Intersoft ClientUI Documentation
OverflowHandleVisibility Property
See Also  Send Feedback
Intersoft.Client.UI.Aqua Namespace > UXToolBar Class : OverflowHandleVisibility Property






Specifies the visibility of overflow handle element.

Syntax

Visual Basic (Declaration) 
<CategoryAttribute("Common Properties")>
Public Property OverflowHandleVisibility As OverflowDisplayVisibility
Visual Basic (Usage)Copy Code
Dim instance As UXToolBar
Dim value As OverflowDisplayVisibility
 
instance.OverflowHandleVisibility = value
 
value = instance.OverflowHandleVisibility
C# 
[CategoryAttribute("Common Properties")]
public OverflowDisplayVisibility OverflowHandleVisibility {get; set;}
Delphi 
public read-write property OverflowHandleVisibility: OverflowDisplayVisibility;
JScript 
CategoryAttribute("Common Properties")
public function get,set OverflowHandleVisibility : OverflowDisplayVisibility
Managed Extensions for C++ 
[CategoryAttribute("Common Properties")]
public: __property OverflowDisplayVisibility get_OverflowHandleVisibility();
public: __property void set_OverflowHandleVisibility( 
   OverflowDisplayVisibility value
);
C++/CLI 
[CategoryAttribute("Common Properties")]
public:
property OverflowDisplayVisibility OverflowHandleVisibility {
   OverflowDisplayVisibility get();
   void set (    OverflowDisplayVisibility value);
}

Remarks

UXToolBar is designed to address the needs of dynamic applications that suppose to work consistently in resolution independent scenarios. One of the key features in UXToolBar is the autofit and overflow capability in which the tool bar automatically measures the available groups and commands to fit the available space.

The overflow feature is enabled by default. To disable this feature, you set the OverflowHandleVisibility property of the UXToolBar to Collapsed.

By default, when the screen real estate is not sufficient to show all items in the tool bar, certain items would be removed from the UI based on the OverflowPriority and OverflowMode of each item in the tool bar. The items which are removed due to the insufficient space are called overflowing items. 

UXToolBar implements its own advanced panels to sophisticatedly handle the overflow mechanism where the overflowing items are virtually moved to the dropdown panel, yet physically existed in the original object model.

You can access the overflowing items through the overflow handle that appears in the right edge of the tool bar interface. You can control the visibility of the overflow handle through OverflowHandleVisibility property using one of the three modes described in the following:

  • Visible
    The overflow handle is always visible regardless of whether the tool bar contains overflowing items. This is the default value of the property.
     
  • AsNeeded
    The overflow handle is displayed only when needed. When all items are visible in the tool bar, the overflow handle is collapsed. On the other hand, the overflow handle would become visible when the tool bar generates overflowing items.
     
  • Collapsed
    The overflow handle is permanently hidden. Consequently, it also disables the overflow feature.
     

The following illustration shows an overview of the overflow concept and the related user interface of UXToolBar.

 

For more information about UXToolBar, see UXToolBar Overview.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2012 All Rights Reserved.