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.Composition (in TomsToolbox.Wpf.Composition.dll) Version: 2.21.0+44d18b541fc9419ec3c549350a832394661b2a4d
XMLNS for XAML: Not mapped to an xmlns.

Syntax

Copy

public abstract class CommandSourceFactory<T> : DependencyObject, 
	IComposablePartFactory, ICommandSourceFactory
where T : CommandSource

Public MustInherit Class CommandSourceFactory(Of T As CommandSource)
	Inherits DependencyObject
	Implements IComposablePartFactory, ICommandSourceFactory

Type Parameters

T: The derived type of the hosted CommandSource.

The CommandSourceFactoryT type exposes the following members.

Constructors

	Name	Description
	CommandSourceFactoryT	Initializes a new instance of the CommandSourceFactoryT class

Top

Properties

	Name	Description
	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.
	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.
	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

Methods

	Name	Description
	Attach	Attaches the specified command. The last command attached will become the active command, while the previous command will be pushed on a stack.
	CreateCommandSource	Creates a new CommandSource or derived object.
	Detach	Detaches the specified command. If the detached command was the active command, the previous command from the stack will become the active command.
	GetPart	Gets the part for the specified context.
	Replace	Replaces the specified old command with the new command, preserving it's position in the command stack.

Top

Fields

	Name	Description
	GroupNameKey	The key for the TextAttribute that defines the default value for the GroupName
	IconUriKey	The key for the TextAttribute that defines the default Uri for the Icon
	IsCheckableKey	The key for the TextAttribute that defines the default value for the IsCheckable
	ShowTextOnButtonsKey	The key for the TextAttribute that defines the default value for the ShowTextOnButtons
	SubRegionIdKey	The key for the TextAttribute that defines the default SubRegionId

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	Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions)
	TryFindAncestorT	Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions)
	TryFindAncestorOrSelfT	Returns the first element in the ancestor list that implements the type of the type parameter. (Defined by DependencyObjectExtensions)
	TryFindAncestorOrSelfT	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