Version

UltraTaskPaneToolbar Class Members

The following tables list the members exposed by UltraTaskPaneToolbar.

Public Constructors
 NameDescription
Public ConstructorUltraTaskPaneToolbar ConstructorOverloaded.   
Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyAccessibilityObjectGets the System.Windows.Forms.AccessibleObject for this toolbar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public PropertyAccessibleDescriptionGets or sets a description of the visual appearance of the toolbar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public PropertyAccessibleNameGets or sets the accessible name of the toolbar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public PropertyActiveCaptionAppearanceReturns or sets the appearance used to render the caption area when when a control associated with the 'SelectedTaskPaneTool' is active.  
Public PropertyAllowNavigationViaMenuReturns or sets a value indicating if the visible TaskPaneTool instances in the tools collection of the UltraTaskPaneToolbar can be selected by the end-user using a menu tool displayed in the header toolbar.  
Public PropertyAllowNavigationViaMenuResolvedReturns a resolved value indicating whether a menu tool is displayed in the header toolbar which may be used to select the different task pane tools in the UltraToolbarBase.Tools collection.  
Public PropertyAllowResizeReturns or sets a value indicating if the UltraTaskPaneToolbar can be resized by the end-user.  
Public PropertyAppearanceReturns or sets the appearance used to render the background appearance for the task pane toolbar.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyDockedColumnGets or sets the logical column in which the UltraToolbar is docked. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyDockedContentExtentReturns or sets the extent of the content area of the UltraTaskPaneToolbar when docked.  
Public PropertyDockedContentExtentMaxReturns or sets the maximum extent of the content area of the UltraTaskPaneToolbar when docked.  
Public PropertyDockedContentExtentMinReturns or sets the minimum extent of the content area of the UltraTaskPaneToolbar when docked.  
Public PropertyDockedPositionGets or sets the docked location of the UltraToolbar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyDockedRowGet or sets the row in which the UltraToolbar is docked. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyFloatingContentSizeReturns or sets the size of the content area when the toolbar is displayed in a floating window.  
Public PropertyFloatingContentSizeMaxReturns or sets the maximum size for the content area when the toolbar is displayed in a floating window.  
Public PropertyFloatingContentSizeMinReturns or sets the minimum size for the content area when the toolbar is displayed in a floating window.  
Public PropertyFloatingLocationGets or sets the location (in screen coordinates) of the floating window for the UltraToolbar when the UltraToolbar.DockedPosition is Floating. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyFloatingSizeGets or sets the size of the floating window for the UltraToolbar when the UltraToolbar.DockedPosition is Floating. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyHasActiveCaptionAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHasAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHasHotTrackScrollButtonAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHasNavigationButtonAreaAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHasScrollButtonAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHeightOverridden. Read-only property that returns the logical height of the toolbar.  
Public PropertyHomeTaskPaneToolReturns or sets the tool representing the "home" item. The SelectedTaskPaneTool will be set to the HomeTaskPaneTool when the home navigation button is pressed.  
Public PropertyHotTrackScrollButtonAppearanceReturns or sets the appearance for the scroll buttons used to scroll the contents of the control associated with the 'SelectedTaskPaneTool' when the button is hot-tracked.  
Public PropertyIndexGets the index of the toolbar in the ToolbarsCollection. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyIsActiveReturns a boolean indicating if the header area of the toolbar is displayed as active. The toolbar is considered active when the contained control is active.  
Public PropertyIsMainMenuBarGets or sets the value indicating whether the UltraToolbar is the main menu bar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyIsStockToolbarReturns or sets whether the UltraToolbar is a stock toolbar or was created by the user via the runtime customizer. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyKeyGets or sets a value that uniquely identifies an object in a collection. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyKeyTipGets or sets a string with a maximum of 3 characters that represents the mnemonic that is displayed when using keytips. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyNavigationButtonAreaAppearanceReturns or sets the appearance used to render the area behind the task pane navigation buttons.  
Public PropertyNavigationButtonStyleReturns or sets a value indicating how the navigation buttons will navigation the task pane tools and can also be used to hide the tools.  
Public PropertyNavigationButtonStyleResolvedReturns the resolved NavigationButtonStyle  
Public PropertyNavigationMenuSettingsReturns a MenuSettings instance used to alter the appearance of the dropdown containing the TaskPaneTool items.  
Public PropertyNotificationBadgeSettingsThe NotificationBadgeSettings for the whole Toolbar (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public PropertyParentCollectionGets the ToolbarsCollection that owns the UltraToolbar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyScrollButtonAppearanceReturns or sets the default appearance for the scroll buttons used to scroll the contents of the control associated with the 'SelectedTaskPaneTool'.  
Public PropertyScrollPositionReturns or sets the current scroll position for the Control of the SelectedTaskPaneTool.  
Public PropertyScrollPositionMaximumReturns the maximum scroll position.  
Public PropertyScrollPositionMinimumReturns the minimum scroll position.  
Public PropertySelectedTaskPaneToolReturns or sets the currently selected task pane tool.  
Public PropertySettingsGets the ToolbarSettings object for the UltraToolbar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertySettingsResolvedGets the ToolbarSettingsResolved object which contains resolved versions of most properties on the ToolbarSettings object. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyShowHomeButtonReturns or sets a value indicating whether the home navigation button will be displayed.  
Public PropertyShowHomeButtonResolvedReturns the resolved value indicating if the home navigation button will be displayed.  
Public PropertyShowInToolbarListGets or sets the value indicating whether the UltraToolbar shows up in the customization dialog at runtime. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTearawayToolOwnerGets the TearawayToolBase derived tool that this UltraToolbar is owned by. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyTextGets or sets the description of the toolbar displayed in the customization dialogs and in the caption of the floating toolbar window. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyToolbarsManagerGets the UltraToolbarsManager component the UltraToolbar is owned by. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyToolResizeModeReturns or sets the default value indicating how the Control of the SelectedTaskPaneTool will be resized when the tool is selected or when the toolbar is resized.  
Public PropertyToolsReturns a ToolsCollection of ToolBase objects, 1 for each ToolBase in the UltraToolbar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public PropertyUIElementGets the UltraToolbarBase.UIElement for the UltraToolbar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public PropertyUIRoleOverridden. Returns the UIRole of this toolbar.  
Public PropertyUnderlyingToolbarGets the MDI child toolbar that underlies this toolbar. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyVisibleGets or sets the value indicating whether the UltraToolbar is visible. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public PropertyVisibleResolvedGets the resolved value of the UltraToolbar.Visible property on the UltraToolbar object taking into account the toolbar's MDI merge status. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public PropertyWidthOverridden. Read-only property that returns the logical width of the toolbar.  
Protected Properties
 NameDescription
Protected PropertyIsVisibleGets the value indicating if the toolbar is visible. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
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 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 MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
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 MethodRepositionOverloaded. Repositions the UltraToolbar to the specified dock area and dock row, ensuring that it is the only toolbar on the dock row. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetOverridden. Resets all properties of the UltraToolbar to their default values.  
Public MethodResetAccessibleDescriptionResets the UltraToolbarBase.AccessibleDescription property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public MethodResetAccessibleNameResets the UltraToolbarBase.AccessibleName property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public MethodResetActiveCaptionAppearanceResets the ActiveCaptionAppearance property to its default value.  
Public MethodResetAllowNavigationViaMenuResets the AllowNavigationViaMenu property to its default value.  
Public MethodResetAllowResizeResets the AllowResize property to its default value.  
Public MethodResetAppearanceResets the Appearance property to its default value.  
Public MethodResetDockedColumnResets the UltraToolbar.DockedColumn property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetDockedContentExtentResets the DockedContentExtent property to its default value.  
Public MethodResetDockedContentExtentMaxResets the DockedContentExtentMax property to its default value.  
Public MethodResetDockedContentExtentMinResets the DockedContentExtentMin property to its default value.  
Public MethodResetDockedPositionResets the UltraToolbar.DockedPosition property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetDockedRowResets the UltraToolbar.DockedRow property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetFloatingContentSizeResets the FloatingContentSize property to its default value.  
Public MethodResetFloatingContentSizeMaxResets the FloatingContentSizeMax property to its default value.  
Public MethodResetFloatingContentSizeMinResets the FloatingContentSizeMin property to its default value.  
Public MethodResetFloatingLocationResets the UltraToolbar.FloatingLocation property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetFloatingSizeResets the UltraToolbar.FloatingSize property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetHotTrackScrollButtonAppearanceResets the HotTrackScrollButtonAppearance property to its default value.  
Public MethodResetIsMainMenuBarResets the UltraToolbar.IsMainMenuBar property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetKeyOverriden - does nothing. The Key property is not resettable. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetNavigationButtonAreaAppearanceResets the NavigationButtonAreaAppearance property to its default value.  
Public MethodResetNavigationButtonStyleResets the NavigationButtonStyle property to its default value.  
Public MethodResetNavigationMenuSettingsResets the NavigationMenuSettings property to its default value.  
Public MethodResetNotificationBadgeSettingsSets the NotificationBadgeSettings to its default value (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public MethodResetScrollButtonAppearanceResets the ScrollButtonAppearance property to its default value.  
Public MethodResetSettingsResets the UltraToolbar.Settings property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetShowHomeButtonResets the ShowHomeButton property to its default value.  
Public MethodResetShowInToolbarListResets the UltraToolbar.ShowInToolbarList property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetStateResets the UltraToolbar to its original state undoing any changes that were made at runtime. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetTextResets the UltraToolbar.Text property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodResetToolResizeModeResets the ToolResizeMode property to its default value.  
Public MethodResetToolsResets the UltraToolbarBase.Tools property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public MethodResetVisibleResets the UltraToolbar.Visible property to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodShouldSerializeOverridden. Determines whether any properties of the object differ from their default values.  
Public MethodShouldSerializeKeyDetermines whether the UltraToolbar.Key property is set to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodShouldSerializeNotificationBadgeSettingsReturns true if the NotificationBadgeSettings should be serialized (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodToStringReturns the key value appended with the text . (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodCreateUIAutomationStubOverridden. Creates the UI automation stub.  
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodGetAutomationProviderGets the automation provider. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Protected MethodGetNotificationSettingsOwnerParentOverridden in case the Toolbar is BumpedToolsToolbar (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
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 MethodOnAddedToCollectionOverridden. Called when this object is being added to the specified collection.  
Protected MethodOnDeserializationInvoked after the entire object graph has been deserialized.  
Protected MethodOnDisposeOverridden. Invoked when the object is disposed.  
Protected MethodOnObjectPropChangedOverridden. Invoked when the Infragistics.Shared.SubObjectBase.NotifyPropChange(System.Enum) method is used to indicate that a property on the object or sub object has changed.  
Protected MethodOnRemovedFromCollectionCalled when the object is being removed from the collection. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Protected MethodOnSubObjectPropChangedOverridden. Called when a property has changed on a sub object.  
Protected MethodResetInternedKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodShouldSerializeActiveCaptionAppearanceDetermines whether the ActiveCaptionAppearance property is set to its default value.  
Protected MethodShouldSerializeAllowNavigationViaMenuDetermines whether the AllowNavigationViaMenu property is set to its default value.  
Protected MethodShouldSerializeAllowResizeDetermines whether the AllowResize property is set to its default value.  
Protected MethodShouldSerializeAppearanceDetermines whether the Appearance property is set to its default value.  
Protected MethodShouldSerializeDockedContentExtentDetermines whether the DockedContentExtent property is set to its default value.  
Protected MethodShouldSerializeDockedContentExtentMaxDetermines whether the DockedContentExtentMax property is set to its default value.  
Protected MethodShouldSerializeDockedContentExtentMinDetermines whether the DockedContentExtentMin property is set to its default value.  
Protected MethodShouldSerializeFloatingContentSizeDetermines whether the FloatingContentSize property is set to its default value.  
Protected MethodShouldSerializeFloatingContentSizeMaxDetermines whether the FloatingContentSizeMax property is set to its default value.  
Protected MethodShouldSerializeFloatingContentSizeMinDetermines whether the FloatingContentSizeMin property is set to its default value.  
Protected MethodShouldSerializeHomeTaskPaneToolDetermines whether the HomeTaskPaneTool property is set to its default value.  
Protected MethodShouldSerializeHotTrackScrollButtonAppearanceDetermines whether the HotTrackScrollButtonAppearance property is set to its default value.  
Protected MethodShouldSerializeIsMainMenuBarDetermines whether the UltraToolbar.IsMainMenuBar property is set to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Protected MethodShouldSerializeNavigationButtonAreaAppearanceDetermines whether the NavigationButtonAreaAppearance property is set to its default value.  
Protected MethodShouldSerializeNavigationButtonStyleDetermines whether the NavigationButtonStyle property is set to its default value.  
Protected MethodShouldSerializeNavigationMenuSettingsDetermines whether the NavigationMenuSettings property is set to its default value.  
Protected MethodShouldSerializeScrollButtonAppearanceDetermines whether the ScrollButtonAppearance property is set to its default value.  
Protected MethodShouldSerializeSelectedTaskPaneToolDetermines whether the SelectedTaskPaneTool property is set to its default value.  
Protected MethodShouldSerializeShowHomeButtonDetermines whether the ShowHomeButton property is set to its default value.  
Protected MethodShouldSerializeShowInToolbarListDetermines whether the UltraToolbar.ShowInToolbarList property is set to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Protected MethodShouldSerializeToolsDetermines whether the UltraToolbarBase.Tools property is set to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbarBase)
Protected MethodShouldSerializeVisibleDetermines whether the UltraToolbar.Visible property is set to its default value. (Inherited from Infragistics.Win.UltraWinToolbars.UltraToolbar)
Public Events
 NameDescription
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
See Also