Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: form :: component ::

unpublished service NavigationToolBar
Usage Restrictions
not published
Description
This service specifies the model for control which provides controller functionality for a DataForm, such as navigating or filtering the form.

Included Services - Summary
::com::sun::star::form::FormControlModel
(referenced entity's summary:)
specifies a control model within a form.
Properties' Summary
short
Border
denotes the border style of the control. Allowed values are  
boolean
Enabled
determines whether the control is enabled or disabled.  
::com::sun::star::awt::FontDescriptor
FontDescriptor
contains the font attributes for the text in the control  
long
TextColor
specifies the text color (as RGB value) of the control.  
long
TextLineColor
specifies the text line color (as RGB value) of the control.  
long
FontRelief
specifies the relief for the font described in FontDescriptor  
long
FontEmphasisMark
specifies the emphasis mark for the font described in FontDescriptor  
short
IconSize
specifies the size of the icons in the control  
boolean
ShowPosition
determines whether the control should provide functionality for positioning the parent form  
boolean
ShowNavigation
determines whether the control should provide functionality for navigating the parent form  
boolean
ShowRecordActions
determines whether the control should provide functionality for acting on the current record of the parent form  
boolean
ShowFilterSort
determines whether the control should provide functionality for filtering and sorting the parent form  
long
RepeatDelay
specifies a repeat delay for the control  
Included Services - Details
::com::sun::star::form::FormControlModel
(referenced entity's summary:)
specifies a control model within a form.
Properties' Details
Border
short Border;
Description
denotes the border style of the control. Allowed values are
  • 0: no border at all
  • 1: 3D border
  • 2: simple flat
Enabled
boolean Enabled;
Description
determines whether the control is enabled or disabled.
FontDescriptor
::com::sun::star::awt::FontDescriptor FontDescriptor;
Description
contains the font attributes for the text in the control
TextColor
long TextColor;
Description
specifies the text color (as RGB value) of the control.
TextLineColor
long TextLineColor;
Description
specifies the text line color (as RGB value) of the control.

This color is used if the FontDescriptor defines that the text in the control should be underlined or stroke out.

FontRelief
long FontRelief;
Description
specifies the relief for the font described in FontDescriptor

The value must be one of the ::com::sun::star::text::FontRelief constants.

FontEmphasisMark
long FontEmphasisMark;
Description
specifies the emphasis mark for the font described in FontDescriptor

The value must be one of the ::com::sun::star::text::FontEmphasis constants.

IconSize
short IconSize;
Description
specifies the size of the icons in the control

At least the following values are to be supported:

  • 0: small icons (16x16)
  • 1: medium size icons (26x26)
ShowPosition
boolean ShowPosition;
Description
determines whether the control should provide functionality for positioning the parent form
ShowNavigation
boolean ShowNavigation;
Description
determines whether the control should provide functionality for navigating the parent form
ShowRecordActions
boolean ShowRecordActions;
Description
determines whether the control should provide functionality for acting on the current record of the parent form
ShowFilterSort
boolean ShowFilterSort;
Description
determines whether the control should provide functionality for filtering and sorting the parent form
RepeatDelay
long RepeatDelay;
Description
specifies a repeat delay for the control

Some buttons of a NavigationToolBar may show repeating behaviour, e.g. may be repeatedly triggered when the user keeps the mouse pressed over such a button.
The delay between two such triggers (in milliseconds) is specified with this property.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.