CommandSource Class

Command declaration to be used with visual composition.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      TomsToolbox.Wpf.CompositionCommandSource

Namespace: TomsToolbox.Wpf.Composition
Assembly: TomsToolbox.Wpf.Composition (in TomsToolbox.Wpf.Composition.dll)

Syntax

Copy

public class CommandSource : DependencyObject

Public Class CommandSource
	Inherits DependencyObject

The CommandSource type exposes the following members.

Constructors

	Name	Description
	CommandSource	Initializes a new instance of the CommandSource class.

Top

Properties

	Name	Description
	Command	Gets the command represented by this CommandSourceFactory. This can be bound to a menu's or button's Command property.
	Description	Gets the tool tip to be shown in the UI. Usually this is a localized text describing the command.
	GroupName	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.
	Header	Gets the header to be shown in the UI. Usually this is a localized text naming the command.
	Icon	Gets the icon to be shown in the UI, or null to show no icon.
	IsAnyTargetAttached	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.
	IsCheckable	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.
	IsChecked	Gets or sets a value indicating whether this instance is checked. This can be bound to a checkable menu item or toggle button.
	ShowTextOnButtons	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.
	SubRegionId	Gets the id of the region sub-items can register for.
	Tag	Gets a tag that can be bound to the target objects tag.

Top

Fields

	Name	Description
	CommandProperty	Identifies the Command dependency property
	IsAnyTargetAttachedProperty	Identifies the IsAnyTargetAttached dependency property
	IsCheckedProperty	Identifies the IsChecked dependency property

Top

Extension Methods

	Name	Description
	Ancestors	Returns an enumeration of the ancestor elements in the logical tree of this element. (Defined by DependencyObjectExtensions.)
	AncestorsAndSelf	Returns an enumeration of elements that contain this element, and the ancestors in the logical tree of this element. (Defined by DependencyObjectExtensions.)
	GetExportProvider	Gets the active export provider for the specified object. (Defined by ExportProviderLocator.)
	GetMissingExportProviderMessage	Gets the message to show when an export provider could not be located in the visual tree. (Defined by ExportProviderLocator.)
	GetRootVisual	Gets the root visual for the item. (Defined by DependencyObjectExtensions.)
	GetValueT	Gets the value of a dependency property using SafeCastT(Object). (Defined by DependencyObjectExtensions.)
	GetWindowHandle	Gets the window handle of the HwndSource hosting this item. (Defined by DependencyObjectExtensions.)
	SafeCastT	Performs a cast from object to T, avoiding possible null violations if T is a value type. (Defined by ObjectExtensions.)
	SetExportProvider	Sets the export provider. (Defined by ExportProviderLocator.)
	TryFindAncestorT	Overloaded. Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions.)
	TryFindAncestorT(FuncT, Boolean)	Overloaded. Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions.)
	TryFindAncestorOrSelfT	Overloaded. Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions.)
	TryFindAncestorOrSelfT(FuncT, Boolean)	Overloaded. Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions.)
	TryGetExportProvider	Gets the active export provider for the specified object, or null if no export provider is registered. (Defined by ExportProviderLocator.)
	TryGetRootVisual	Gets the root visual for the item. (Defined by DependencyObjectExtensions.)
	VisualAncestors	Returns an enumeration of the ancestor elements in the visual tree of this element. (Defined by DependencyObjectExtensions.)
	VisualAncestorsAndSelf	Returns an enumeration of elements that contains this element, and the ancestors in the visual tree of this element. (Defined by DependencyObjectExtensions.)
	VisualChildren	Enumerates the immediate children of the specified item. (Defined by DependencyObjectExtensions.)
	VisualChildrenAndSelf	Enumerates the specified item and it's immediate children. (Defined by DependencyObjectExtensions.)
	VisualDescendants	Enumerates all visuals descendants of the specified item. (Defined by DependencyObjectExtensions.)
	VisualDescendantsAndSelf	Enumerates the specified item and all it's visual descendants. (Defined by DependencyObjectExtensions.)

Top

Reference

TomsToolbox.Wpf.Composition Namespace

System.WindowsDependencyObject