C1CommandHolder Class

Holds C1Command objects defined on the form.

Inheritance

object

MarshalByRefObject

Component

C1CommandHolder

Implements

Namespace: C1.Win.Command

Assembly: C1.Win.Command.4.8.dll

Syntax

[C1Description("C1CommandHolder", "Represents a container for all commands on a form.")]
public class C1CommandHolder : Component, IComponent, IDisposable, ISupportInitialize, IExtenderProvider

<C1Description("C1CommandHolder", "Represents a container for all commands on a form.")>
Public Class C1CommandHolder
    Inherits Component
    Implements IComponent, IDisposable, ISupportInitialize, IExtenderProvider

Constructors

Name	Description
C1CommandHolder()	Initializes a new instance of the C1CommandHolder class.

Properties

Name	Description
Animation	Gets or sets a value indicating whether to use animation in menus.
AutoSaveLayout	Gets or sets the value indicating whether to automatically save the toolbars layout (for this to work, Layout must be added to dynamic properties).
Commands	Gets the collection of commands.
CustomizerFormClassName	Gets or sets the class name of the Customizer form.
ImageList	Gets or sets the image list for command images.
ImageTransparentColor	Gets or sets the transparent color for images not in image list.
Layout	Gets or sets the toolbars layout; To enable automatic layout persistence, add this property to dynamic properties.
LayoutKeyName	Gets or sets a name of layout dynamic key in application config file.
MainMenu	Returns the main menu for the form.
NewToolbarFormClassName	Gets or sets the class name of the Customizer's new toolbar dialog form.
RecentLinksRunCount	Gets or sets the value indicating how many times the app must be run before rarely used menu items start hiding.
RecentLinksThreshold	Gets or sets the threshold (in percent) for an item to be considered rarely used. The higher the value, the more items are hidden.
SelectMdiChildFormClassName	Gets or sets the class name of the MDI child selection dialog form.
ShowInvisibleItems	Gets or sets the value indicating whether invisible menu and toolbar items are shown at design time.
ShowMenuTooltips	Gets or sets the value indicating whether to show tooltip texts when mouse cursor is over menu item.
ShowNonRecentLinksHoverDelay	Gets or sets the delay (in seconds) for the mouse to hover over the parent menu item in order to show all rarely used item.
ShowToolbarTooltips	Gets or sets the value indicating whether to show tooltip texts when mouse cursor is over toolbutton.
SkipDisabledMenuItems	Gets or sets a value indicating whether the user can give the focus to the CommandLink using keys when the Command is disabled.
SmoothImages	Draw smooth images for currently unselected items.
StateUpdateOnIdle	Gets or sets the value indicating whether to update commands' status when idle.
SuperTooltip
UIStrings	Gets the array of user interface strings.
VisualStyle	Gets or sets the visual style of all C1Command controls on the form (can be overridden by individual controls).

Methods

Name	Description
BeginInit()
CommandHolderByForm(Control)	Returns the command holder for the specified form, if it exists.
CreateCommand()	Creates a new command and adds it to the Commands collection.
CreateCommand(Type)	Creates a new command and adds it to the Commands collection.
CreateCommandHolder(Control)	Creates a command holder and initializes it.
Customize()	Invokes toolbar customizer.
Dispose(bool)	Releases the resources used by the C1CommandHolder.
EndInit()
FindCommand(Shortcut)	Gets the C1Command associated with the shortcut.
GetC1Command(object)	Determines the command (of the type C1Command or inherited) invoked when the control's default (or, if there is none, Click) event fires.
GetC1ContextMenu(object)	Gets a context menu contained within the C1CommandHolder.
IC1GetAmbientRootSource(string)	Get active holder of current VisualStyle.
LayoutLoadFromAppConfig()	Loads layout data from the application config file.
LayoutReset()	Reset layout.
LayoutSaveInAppConfig()	Saves the layout data into the application config file.
MergeCommandLinks(C1CommandLinks, C1CommandLinks, C1CommandLinks)	Merges command links from links1 and links2 into result, using merge rules specified with links, similar to MDI merge.
MergeCommandLinks(C1CommandLinks, C1CommandLinks, C1CommandLinks, bool)	Merges command links from links1 and links2 into result, using merge rules specified with links, similar to MDI merge.
OnCustomizationFinished(EventArgs)	This method is for internal use only.
OnCustomizationStarted(EventArgs)	called for restoring layout of a single toolbar
OnCustomizeLinkAdded(CustomizeLinkEventArgs)	This method is for internal use only.
OnCustomizeLinkRemoved(CustomizeLinkEventArgs)	This method is for internal use only.
OnCustomizeToolBarAdded(CustomizeToolBarEventArgs)	This method is for internal use only.
OnCustomizeToolBarRemoved(CustomizeToolBarEventArgs)	This method is for internal use only.
OnRecentLinksRunCountChanged(EventArgs)	This method is for internal use only.
OnRecentLinksThresholdChanged(EventArgs)	This method is for internal use only.
OnShowNonRecentLinksHoverDelayChanged(EventArgs)	This method is for internal use only.
OnVisualStyleChanged(EventArgs)	Invokes the VisualStyleChanged event.
ResetC1Command(object)	This method is for internal use only.
ResetC1ContextMenu(object)	This method is for internal use only.
ResetCustomizerFormClassName()	This method is for internal use only.
ResetNewToolbarFormClassName()	This method is for internal use only.
ResetSelectMdiChildFormClassName()	This method is for internal use only.
ResetToolbar(string)	Called for restoring layout of a single toolbar.
ResetUIStrings()	This method is for internal use only.
ResetVisualStyle()	Restore the VisualStyle property to its default value.
SaveDefaultLayout()	Sets the current layout to be the default (the one the customizer's reset button reverts to).
SetC1Command(object, C1Command)	Set the command (of the type C1Command or inherited) invoked when the control's default (or, if there is none, Click) event fires.
SetC1ContextMenu(object, C1ContextMenu)	Sets a context menu contained within the C1CommandHolder.
ShouldSerializeC1Command(object)	This method is for internal use only.
ShouldSerializeC1ContextMenu(object)	This method is for internal use only.
ShouldSerializeCustomizerFormClassName()	This method is for internal use only.
ShouldSerializeImageTransparentColor()	This method is for internal use only.
ShouldSerializeNewToolbarFormClassName()	This method is for internal use only.
ShouldSerializeSelectMdiChildFormClassName()	This method is for internal use only.
ShouldSerializeUIStrings()	This method is for internal use only.
ShouldSerializeVisualStyle()	Indicates whether the VisualStyle has a default value.
UnmergeCommandLinks(C1CommandLinks)	Unmerges the two collections of links merged previously by MergeCommandLinks.
UnmergeCommandLinks(C1CommandLinks, C1CommandLinks, C1CommandLinks)	Unmerges the two collections of links merged previously by MergeCommandLinks.

Events

Name	Description
CommandClick	Occurs when the command is invoked by the user.
CustomizationFinished	Occurs when customization mode finishes.
CustomizationStarted	Occurs when customization mode starts.
CustomizeLinkAdded	Occurs when a new command link is added to an existing toolbar during customization.
CustomizeLinkRemoved	Occurs when a command link is removed from a toolbar during customization.
CustomizeToolBarAdded	Occurs when a new toolbar is added or a hidden toolbar becomes visible during customization.
CustomizeToolBarRemoved	Occurs when a visible toolbar is hidden during customization.
LayoutLoad	Occurs when layout string must be loaded from app config file.
LayoutSave	Occurs when layout string must be saved in app config file.
RecentLinksRunCountChanged	Occurs when the value of the RecentLinksRunCount property changes.
RecentLinksThresholdChanged	Occurs when the value of the RecentLinksRunCount property changes.
ShowNonRecentLinksHoverDelayChanged	Occurs when the value of the ShowNonRecentLinksHoverDelay property changes.
VisualStyleChanged	Occurs when the VisualStyle property has changed.