Version

PopupToolBase Class Members

The following tables list the members exposed by PopupToolBase.

Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyAccessibilityObjectReturns the System.Windows.Forms.AccessibleObject for this tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyAccessibleRoleResolvedReturns the accessible role for this tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyAllowMultipleInstancesResolvedReturns the value of the SharedProps.AllowMultipleInstances property on the ToolBase.SharedProps object of the ToolBase.UnderlyingTool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyBoundsGets the location and size of the tool in screen coordinates. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCanActivateReturns whether the ToolBase can become the active ToolBase. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCaptionResolvedReturns the resolved value of the ToolPropsBase.Caption property on the ToolBase.SharedProps and ToolBase.InstanceProps objects, taking into account any customization performed by the end user. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCheckedReturns or sets whether the PopupToolBase is currently checked.  
Public PropertyComponentRoleReturns the ComponentRole of the UltraToolbarsManager (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyControlReturns the Control attached to the tool (read-only). (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCustomizedCaptionReturns or sets the value of any user customization of the ToolPropsBase.Caption property. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCustomizedDisplayStyleReturns or sets the value of any user customization of the ToolPropsBase.DisplayStyle property. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCustomizedImageReturns or sets the value of any user customization of the Image displayed by the tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCustomizedIsFirstInGroupReturns or sets the value of any user customization of the IsFirstInGroup property. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCustomizedRecentlyUsedReturns or sets the value of any user customization of the RecentlyUsed property. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCustomizedVisibleReturns the value of any user customization of the visibility of the tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCustomizerCaptionResolvedReturns the string that will appear in the Customize dialog's 'Commands' list. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyCustomizerDescriptionResolvedReturns the resolved value of the SharedProps.CustomizerDescription property on the ToolBase.SharedProps object of the ToolBase.UnderlyingTool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyDefaultSizeReturns the default size of the tool (read-only). (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyDisplayStyleResolvedReturns the resolved value of the ToolPropsBase.DisplayStyle property on the ToolBase.SharedProps and ToolBase.InstanceProps objects, taking into account any customization performed by the end user. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyDropDownArrowStyleReturns or sets the style of the dropdown arrow for the PopupToolBase.  
Public PropertyDropDownArrowStyleResolvedReturns the resolved DropDownArrowStyle for this tool.  
Public PropertyEnabledResolvedReturns whether the tool is enabled. It resolves the value based on the ToolBase.SharedProps's SharedProps.Enabled and UltraToolbarsManager's Enabled properties. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyHeightReturns the height of this instance of the tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyIndexReturns the index of the tool in the ToolsCollectionBase. This property is read-only. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyInstanceDisplaysImageReturns whether this tool instance displays its image. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyInstanceDisplaysTextReturns whether this tool instance displays its text. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyInstancePropsReturns the ToolBase.InstanceProps object which contains properties that are unique to a ToolBase instance. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyIsActiveToolReturns or sets whether this ToolBase is the active ToolBase. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyIsControlContainerReturns whether the tool is a container tool that can contain other controls. This property is read-only. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyIsFirstInGroupResolvedReturns the resolved value of the IsFirstInGroup property, taking into account any customization performed by the end user. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyIsOpenReturns whether the PopupToolBase is currently open (i.e. dropped down).  
Public PropertyIsPopularCommandReturns whether this ToolBase is a SharedProps.PopularCommand (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyIsRootToolReturns whether the ToolBase is a root ToolBase (i.e., is in the UltraToolbarsManager component's UltraToolbarsManager.Tools collection). (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyKeyReturns or sets a value that uniquely identifies an object in a collection. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyKeyTipForSegmentedButtonReturns or sets a string with a maximum of 3 characters that represents the mnemonic that is displayed for the segmented drop down arrow when using keytips.  
Public PropertyKeyTipResolvedReturns the resolved value of the ToolPropsBase.KeyTip property on the ToolBase.SharedProps and ToolBase.InstanceProps objects. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyMaxWidthResolvedReturns the resolved value of the ToolPropsBase.MaxWidth property on the ToolBase.SharedProps and ToolBase.InstanceProps objects. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyMinimumSizeReturns the minimum size of the tool (read-only). (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyMinWidthResolvedReturns the resolved value of the ToolPropsBase.MinWidth property on the ToolBase.SharedProps and ToolBase.InstanceProps objects. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerReturns the UltraToolbar, PopupMenuTool or UltraToolbarsManager that owns this tool instance. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsApplicationMenu2010ContentAreaReturns a value indicating whether the tool type is on the content area of the ApplicationMenu2010 (not including the Navigation Menu area). (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsApplicationMenu2010NavigationMenuReturns a value indicating whether the tool type supports being place in a NavigationMenu. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsApplicationMenuAreaReturns a value indicating whether the tool type supports being place in a ApplicationMenu. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsApplicationMenuAreaBaseReturns a value indicating whether the tool type supports being place in a ApplicationMenu or ApplicationMenu2010. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsMenuReturns true if this tool instance is owned by a PopupMenuTool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsNavigationToolbarReturns true if this tool instance is owned by a NavigationToolbar. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsNullReturns true if this tool instance has not been fully initialized and has no owner. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsRibbonGroupReturns a value indicating whether the tool type supports being place in a Ribbon. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsToolbarReturns true if this tool instance is owned by a UltraToolbar. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsToolbarBaseReturns true if this tool instance is owned by a UltraToolbarBase. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwnerIsToolbarsManagerReturns true if this tool instance is owned by the UltraToolbarsManager. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwningApplicationMenu2010NavigationMenuReturns the owning NavigationMenu (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwningApplicationMenuAreaReturns the owning ApplicationMenuArea (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwningApplicationMenuAreaBaseReturns the owning ApplicationMenuAreaBase (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwningMenuReturns the PopupMenuTool that owns this tool instance or null if this tool instance is not owned by a PopupMenuTool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwningNavigationToolbarReturns the NavigationToolbar that owns this tool instance, or null if this instance is not owned by a NavigationToolbar. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwningRibbonGroupReturns the owning RibbonGroup (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwningToolbarReturns the UltraToolbar that owns this tool instance or null if this tool instance is not owned by an UltraToolbar. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyOwningToolbarBaseReturns the UltraToolbarBase that owns this tool instance or null if this tool instance is not owned by an UltraToolbarBase. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyParentCollectionThe ToolsCollectionBase that owns this ToolBase. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyRecentlyUsedResolvedReturns the resolved value of the RecentlyUsed property, taking into account the tool's click activity and any customization performed by the end user. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertySharedPropsReturns the ToolBase.SharedProps object which contains properties that are shared across all instances of the ToolBase. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyShortcutResolvedReturns the resolved value of the SharedProps.Shortcut property on the ToolBase.SharedProps object, taking into account any customization performed by the end user. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyShouldDisplayToolTipOverridden. Returns whether a ToolTip should be displayed for the ToolBase when the mouse hovers over it. This property is read-only.  
Public PropertySpringResolvedReturns the resolved value of the SharedProps.Spring property on the ToolBase.SharedProps and ToolBase.InstanceProps objects. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyToolbarsManagerThe UltraToolbarsManager component that the ToolBase is owned by. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyToolTipTextFormattedResolvedReturns the value of the SharedProps.ToolTipTextFormatted property on the ToolBase.SharedProps object if it was set. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyToolTipTextResolvedReturns the value of the SharedProps.ToolTipText property on the ToolBase.SharedProps object if it was set. Otherwise, returns the value of ToolBase.CaptionResolved. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyToolTipTitleResolvedReturns the value of the SharedProps.ToolTipTitle property on the ToolBase.SharedProps object if it was set. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyUIElementReturns the UI Element for the ToolBase. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyUIRoleForEditAreaReturns the UIRole for the edit area of this tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyUIRoleOnMenusReturns the UIRole of this tool when used on a menu. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyUIRoleOnRibbonGroupsReturns the UIRole of this tool when used on a ribbon group. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyUIRoleOnToolbarsReturns the UIRole of this tool when used on a toolbar. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyUnderlyingToolReturns the underlying tool that this tool points to. Used primarily for the MdiMergePlaceholderTool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyVisibleResolvedReturns the resolved value of the SharedProps.Visible property on the ToolBase.SharedProps and ToolBase.InstanceProps objects. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public PropertyWidthResolvedReturns the resolved value of the ToolPropsBase.Width property on the ToolBase.SharedProps and ToolBase.InstanceProps objects. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected Properties
 NameDescription
Protected PropertyDefaultAccessibleRoleThe default accessible role for this type of tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected PropertyDefaultActionOverridden. The default action for this type of tool.  
Protected PropertyDefaultDropDownArrowStyleAbstract property that returns the default DropDownArrowStyle for this tool (read-only).  
Protected PropertyExtraSharedPropsCountOverridden. Returns the number of extra shared properties required by this class.  
Protected PropertyKeyLowercaseInterned (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertyPrimaryCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Public Methods
 NameDescription
Public MethodBringIntoViewEnsures that the ToolBase is currently in view. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public MethodClosePopupCloses the open popup of any instance of this tool.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodDropDownDisplays the tool's associated dropdown.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeCheckedChanges the Checked property without invoking the ToolBase.ToolClick event.  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodResetOverridden. Resets all properties of the PopupToolBase to their default values.  
Public MethodResetCheckedResets the Checked property to its default value.  
Public MethodResetDropDownArrowStyleResets the DropDownArrowStyle property to its default value.  
Public MethodResetInstancePropsResets all ToolBase.InstanceProps properties to their default values. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public MethodResetKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Public MethodResetKeyTipForSegmentedButtonResets the KeyTipForSegmentedButton property to its default value.  
Public MethodResetSharedPropsResets the ToolBase.SharedProps property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public MethodResetStateResets the ToolBase to its original state undoing any changes that were made at runtime. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public MethodResolveAppearanceOverloaded. Resolves the appearance for the tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public MethodShouldSerializeKeyDetermines whether the ToolBase.Key property is set to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodShowPopupOverloaded. Displays the PopupToolBase as a context popup at the current mouse position.  
Public MethodToStringReturns the key value appended with the type name. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodCompareToCompares this tool to another. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodCreateUIAutomationStubOverridden. Creates the UI Automation stub.  
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodDoDefaultActionOverridden. Performs the default action associated with this tool.  
Protected MethodGetExtraSharedPropsReturns the object held in extra shared props at the specified index. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodGetObjectDataOverridden. Populates the specified System.Runtime.Serialization.SerializationInfo with the data from the object.  
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodNavigateNavigates to another accessible object. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodNotificationBadgeBoundsDetermines the rectangle area of the NotificationUIElement. In this area the tools will display the element will be positioned based on its size and position Can be overridden in the other tools. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodOnAddedToCollectionCalled when this object is being added to the specified collection. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodOnDisposeCalled when disposed. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnPopupToolbarCreatedCalled after a PopupToolbar has been created.  
Protected MethodOnRemovedFromCollectionOverridden. Called when the object is being removed from the collection.  
Protected MethodOnSubObjectPropChangedCalled when a property has changed on a sub object. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodResetInternedKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodResolveAppearancePhasePerforms a phase of a tool's appearance resolution process. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSetExtraSharedPropsSets the object held in ExtraSharedProps at the specified index. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodShouldSerializeCheckedDetermines whether the Checked property is set to its default value.  
Protected MethodShouldSerializeInstancePropsDetermines whether the ToolBase.InstanceProps property is set to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Protected MethodShouldSerializeSharedPropsDetermines whether the ToolBase.SharedProps property is set to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public Events
 NameDescription
Public EventAfterToolActivateOccurs after a tool becomes the active tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventAfterToolCloseupOccurs after a tool closes up. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventAfterToolDeactivateOccurs after a tool ceases to be the active tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventAfterToolDropdownOccurs after a tool drops down. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventAfterToolEnterEditModeOccurs after a tool has entered edit mode. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventAfterToolExitEditModeOccurs after a tool has exited edit mode. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventBeforeToolActivateOccurs before a tool becomes the active tool. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventBeforeToolDropdownOccurs before a tool drops down. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventBeforeToolEnterEditModeCancelable event that occurs before a tool has entered edit mode. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventBeforeToolExitEditModeCancelable event that occurs before a tool has exited edit mode. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Public EventToolClickOccurs when the tool is clicked by the user. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventToolDoubleClickOccurs when a tool is double-clicked by the user. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventToolEditErrorOccurs after the ToolBase.BeforeToolExitEditMode event if the value that the user has entered is invalid. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventToolKeyDownOccurs when a key is pressed when a tool has the input focus. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventToolKeyPressOccurs when a key is pressed and released when a tool has the input focus. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventToolKeyUpOccurs when a key is released when a tool has the input focus. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
Public EventToolValueChangedOccurs when the value of a tool changes. (Inherited from Infragistics.Win.UltraWinToolbars.ToolBase)
See Also