Click or drag to resize

CommandSource Class

Command declaration to be used with visual composition.
Inheritance Hierarchy

Namespace:  TomsToolbox.Wpf.Composition
Assembly:  TomsToolbox.Wpf (in TomsToolbox.Wpf.dll) Version: 1.0.74.0
Syntax
public class CommandSource : DependencyObject

The CommandSource type exposes the following members.

Constructors
  NameDescription
Public methodCommandSource
Initializes a new instance of the CommandSource class.
Top
Properties
  NameDescription
Public propertyCommand
Gets the command represented by this CommandSourceFactory. This can be bound to a menu's or button's Command property.

[CanBeNull]

Public propertyDescription
Gets the tool tip to be shown in the UI. Usually this is a localized text describing the command.

[CanBeNull]

Public propertyGroupName
Gets the name of the group that this command belongs to. If different group names are specified for a target region, the commands can be grouped and the groups separated by a Separator.

[CanBeNull]

Public propertyHeader
Gets the header to be shown in the UI. Usually this is a localized text naming the command.

[CanBeNull]

Public propertyIcon
Gets the icon to be shown in the UI, or null to show no icon.

[CanBeNull]

Public propertyIsAnyTargetAttached
Gets a value indicating whether any target is attached to this source. Some controls like tool bars may want to hide commands that have no target attached rather than only disabling them.
Public propertyIsCheckable
Gets a value indicating whether the control associated with this instance should be checkable, e.g. a MenuItem with IsCheckable or a ToggleButton in a tool bar.
Public propertyIsChecked
Gets or sets a value indicating whether this instance is checked. This can be bound to a checkable menu item or toggle button.
Public propertyShowTextOnButtons
Gets a value indicating whether to show the header text when this command is bound to a button. If false, only the icon should be displayed.
Public propertySubRegionId
Gets the id of the region sub-items can register for.

[CanBeNull]

Public propertyTag
Gets a tag that can be bound to the target objects tag.

[CanBeNull]

Top
Fields
  NameDescription
Public fieldStatic memberCommandProperty
Identifies the Command dependency property

[NotNull]

Public fieldStatic memberIsAnyTargetAttachedProperty
Identifies the IsAnyTargetAttached dependency property

[NotNull]

Public fieldStatic memberIsCheckedProperty
Identifies the IsChecked dependency property

[NotNull]

Top
Extension Methods
  NameDescription
Public Extension MethodAncestors
Returns an enumeration of the ancestor elements in the logical tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodAncestorsAndSelf
Returns an enumeration of elements that contain this element, and the ancestors in the logical tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodGetExportProvider
Gets the active export provider for the specified object.

[NotNull]

(Defined by ExportProviderLocator.)
Public Extension MethodGetRootVisual
Gets the root visual for the item.

[NotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodGetValueT (Defined by DependencyObjectExtensions.)
Public Extension MethodGetWindowHandle
Gets the window handle of the HwndSource hosting this item.
(Defined by DependencyObjectExtensions.)
Public Extension MethodSafeCastT
Performs a cast from object to T, avoiding possible null violations if T is a value type.

[CanBeNull]

(Defined by ObjectExtensions.)
Public Extension MethodSetExportProvider
Sets the export provider.
(Defined by ExportProviderLocator.)
Public Extension MethodTryFindAncestorTOverloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorT(FuncT, Boolean)Overloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorOrSelfTOverloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorOrSelfT(FuncT, Boolean)Overloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryGetExportProvider
Gets the active export provider for the specified object, or null if no export provider is registered.

[CanBeNull]

(Defined by ExportProviderLocator.)
Public Extension MethodTryGetRootVisual
Gets the root visual for the item.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualAncestors
Returns an enumeration of the ancestor elements in the visual tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualAncestorsAndSelf
Returns an enumeration of elements that contains this element, and the ancestors in the visual tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualChildren
Enumerates the immediate children of the specified item.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualChildrenAndSelf
Enumerates the specified item and it's immediate children.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualDescendants
Enumerates all visuals descendants of the specified item.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualDescendantsAndSelf
Enumerates the specified item and all it's visual descendants.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Top
See Also