Click or drag to resize

CommandSourceFactoryT Class

Base class for command declaration to be used with visual composition.
Inheritance Hierarchy
SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      TomsToolbox.Wpf.CompositionCommandSourceFactoryT
        TomsToolbox.Wpf.CompositionCommandSourceFactory

Namespace:  TomsToolbox.Wpf.Composition
Assembly:  TomsToolbox.Wpf (in TomsToolbox.Wpf.dll) Version: 1.0.69.0
Syntax
public abstract class CommandSourceFactory<T> : DependencyObject, 
	IComposablePartFactory, ICommandSourceFactory
where T : CommandSource

Type Parameters

T
The derived type of the hosted CommandSource.

The CommandSourceFactoryT type exposes the following members.

Constructors
  NameDescription
Protected methodCommandSourceFactoryT
Initializes a new instance of the CommandSourceFactoryT class
Top
Properties
  NameDescription
Public propertyDescription
Gets the tool tip to be shown in the UI. Usually this is a localized text describing the command.
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.
Public propertyHeader
Gets the header to be shown in the UI. Usually this is a localized text naming the command.
Public propertyIcon
Gets the icon to be shown in the UI, or null to show no icon.
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 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.
Public propertyTag
Gets a tag that can be bound to the target objects tag.
Top
Methods
  NameDescription
Public methodAttach
Attaches the specified command. The last command attached will become the active command, while the previous command will be pushed on a stack.

[NotNull]

Protected methodCreateCommandSource
Creates a new CommandSource or derived object.

[NotNull]

Public methodDetach
Detaches the specified command. If the detached command was the active command, the previous command from the stack will become the active command.

[NotNull]

Public methodGetPart
Gets the part for the specified context.

[NotNull]

Public methodReplace
Replaces the specified old command with the new command, preserving it's position in the command stack.

[NotNull]

Top
Fields
  NameDescription
Public fieldStatic memberGroupNameKey
The key for the TextAttribute that defines the default value for the GroupName
Public fieldStatic memberIconUriKey
The key for the TextAttribute that defines the default Uri for the Icon
Public fieldStatic memberIsCheckableKey
The key for the TextAttribute that defines the default value for the IsCheckable
Public fieldStatic memberShowTextOnButtonsKey
The key for the TextAttribute that defines the default value for the ShowTextOnButtons
Public fieldStatic memberSubRegionIdKey
The key for the TextAttribute that defines the default SubRegionId
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