General

From LibreOffice Help
Jump to: navigation, search

This General tab enables you to define the general properties of a form control. These properties differ, depending on the control type. Not all of the following properties are available for every control.

Open context menu of a selected form element - choose Control - General tab

Open Form Controls toolbar or Form Design toolbar, click Control icon - General tab

Note.png If you export the current form document to HTML format, the default control values are exported, not the current control values. Default values are determined - depending on the type of control - by the properties' Default value (for example, in text fields), Default status (for check boxes and option fields), and Default selection (for list boxes).

Frame

You can also specify the target frame to display a URL that you open when you click a button that has been assigned the Open document or web page action).

If you click the field, you can select an option from the list that specifies into which frame the next document should be loaded. The following possibilities exist:

Entry Meaning
_blank The next document is created in a new empty frame.
_parent The next document is created in a parent frame. If no parent exists, the document is created in the same frame.
_self The next document is created in the same frame.
_top The next document is created in a top-level window, that is, in the highest frame of the hierarchy; if the current frame is already a top window, the document is created in the current frame.
Note.png The Frame property is relevant for HTML forms, but not for database forms.

Value

In a hidden control, under Value, you can enter the data which is inherited by the hidden control. This data will be transferred when sending the form.

Mouse wheel scroll

Sets whether the value changes when the user scrolls a mouse wheel. Never: No change of the value. When focused: (default) The value changes when the control has the focus and the wheel is pointing at the control and gets scrolled. Always: The value changes when the wheel is pointing at the control and gets scrolled, no matter which control has the focus.

PositionX

Defines the X position of the control, relative to the anchor.

PositionY

Defines the Y position of the control, relative to the anchor.

Anchor

Defines where the control will be anchored.

Width

Defines the width of the control.

Height

Defines the height of the control.

Orientation

Specifies the horizontal or vertical orientation for a scrollbar or spin button.

Visible size

Specifies the size of scrollbar thumb in "value units". A value of ("Scroll value max." minus "Scroll value min." ) / 2 would result in a thumb which occupies half of the background area.

If set to 0, then the thumb's width will equal its height.

Large change

Specify the value to add or subtract when the user clicks next to the slider on the scrollbar.

Small change

Specify the value to add or subtract when the user clicks the arrow icon on the scrollbar.

Password characters

If the user enters a password, you can determine the characters that will be displayed instead of the characters typed by the user. Under Password character, enter the ASCII code of the desired character. You can use the values from 0 to 255.

Tip.png The characters and their ASCII codes can be seen in the Special Characters dialog (Insert - Special Character).

Symbol color

Specifies the color for symbols on controls, for example the arrows on a scrollbar.

Incr./decrement value

Determines intervals to add or subtract with each activation of the spin button control.

Text lines end with

For text fields, select the line end code to be used when writing text into a database column.

Icon Size

Specifies whether the icons in a selected Navigation Bar should be small or large.

Filtering / Sorting

Specifies to show or hide the filtering and sorting items in a selected Navigation Bar control. Filtering and sorting items are the following: Sort ascending, Sort descending, Sort, Automatic filter, Default filter, Apply filter, Reset filter/sort.

Navigation

Specifies to show or hide the navigation items in a selected Navigation Bar control. Navigation items are the following: First record, Previous record, Next record, Last record.

Visible

Defines whether the control will be visible in live mode. In design mode, the control is always visible.

Note that if this property is set to "Yes" (the default), this does not necessarily mean the control will really appear on the screen. Additional constraints are applied when calculating a control's effective visibility. For instance, a control placed in a hidden section in Writer will never be visible at all, until at least the section itself becomes visible.

If the property is set to "No", then the control will always be hidden in live mode.

Older OpenOffice.org versions up to 3.1 will silently ignore this property when reading documents which make use of it.

Scroll value max.

Specify the maximum value of a scrollbar control.

Scroll value min.

Specify the minimum value of a scrollbar control.

Positioning

Specifies to show or hide the positioning items in a selected Navigation Bar control. Positioning items are the following: Record label, Record position, Record count label, Record count.

Literal mask

With masked fields you can specify a literal mask. A literal mask contains the initial values of a form, and is always visible after downloading a form. Using a character code for the Edit mask, you can determine the entries that the user can type into the masked field.

Note.png The length of the literal mask should always correspond to the length of the edit mask. If this is not the case, the edit mask is either cut off or filled with blanks up to the length of the edit mask.

Scale

Resizes the image to fit the size of the control.

Border color

Specifies the border color for controls that have the Border property set to "flat".

Style

Specifies whether Check boxes and Option buttons are displayed in a 3D look (default) or a flat look.

Hide selection

Specifies whether a text selection on a control remains selected when a the focus is no longer on a control. If you set Hide selection to "No", the selected text remains selected when the focus is no longer on the control that contains the text.

Take Focus on Click

If you set this option to "Yes", the Push Button receives the focus when you click the button.

Toggle

Specifies if a Push Button behaves as a Toggle Button. If you set Toggle to "Yes", you can switch between the "selected" and "not selected" control states when you click the button or press the spacebar while the control has the focus. A button in the "selected" state appears "pressed in".

Line count

For combo boxes with the Dropdown property, you can specify how many lines should be displayed in the dropdown list. With control fields which do not have the Dropdown option, the line's display will be specified by the size of the control field and the ‍font size.

Action

You can use navigation actions to design your own database navigation buttons.

The following table describes the actions that you can assign to a button.

Action Description
None No action occurs.
Submit form Sends the data that is entered in other control fields of the current form to the address that is specified in Form Properties under URL.

Enter the URL into the form's data property "URL" text box when you export to a PDF file.

Reset form Resets the settings in other control fields to the predefined defaults (Default Status, Default Selection, Default Value).
Open document / web page Opens the URL that is specified under URL. You can use Frame to specify the target frame.
First record Moves the current form to the first record.
Previous record Moves the current form to the previous record.
Next record Moves the current form to the next record.
Last record Moves the current form to the last record.
Save record Saves the current record, if necessary.
Undo data entry Reverses the changes in the current record.
New record Moves the current form to the insert row.
Delete record Deletes the current record.
Refresh form Reloads the most recently saved version of the current form.

Dropdown

A control field with the dropdown property has an additional arrow button which opens the list of the existing form entries per mouse click. Under Line count, you can specify how many lines (or rows) should be displayed in the dropdown state. Combination fields can have the dropdown property.

Combo boxes that were inserted as columns in a table control are always dropdown as the default.

Alignment / Graphics alignment

The alignment options are left-aligned, right-aligned, and centered. These options are available for the following elements:

  1. Title of Label fields
  2. Content of text fields
  3. Content of table fields in the columns of a table control
  4. Graphics or text that are used in buttons
    The Alignment option for buttons is called Graphics alignment.

Font

For control fields which have visible text or titles, select the display font that you want to use. To open the Font dialog, click the ... button. The selected font is used in control fields names and to display data in table control fields.

AutoFill

The AutoFill function displays a list of previous entries after you start to type an entry.

Label field

Specifies the source for the label of the control. The text of the label field will be used instead of the name of a database field. For example, in the Filter Navigator, Search dialog, and as a column name in the table view.

To define one character of the label as a mnemonic, so that the user can access this control by pressing the character on the keyboard, insert a tilde (~) character in front of the character in the label.

Only the text of a group frame can be used as the label field when using radio buttons. This text applies to all of the radio buttons of the same group.

If you click on the ... button next to the text field, you will see the Label Field Selection dialog. Select a label from the list.

Check the No assignment box to remove the link between a control and the assigned label field.

Width

Sets the column width in the table control field in the units that are specified in the LibreOffice module options. If you want, you can enter a value followed by a valid measurement unit, for example, 2 cm.

Repeat

Specifies if the action of a control such as a spin button repeats when you click the control and hold the mouse button down.

Delay

Specifies the delay in milliseconds between repeating events. A repeating event occurs when you click an arrow button or the background of a scrollbar, or one of the record navigation buttons of a Navigation Bar, and you keep the mouse button pressed for some time. You can enter a value followed by a valid time unit, for example, 2 s or 500 ms.

Record marker

Specifies whether the first column is displayed with row labels, in which the current record is marked by an arrow.

Date format

With date fields you can determine the format for the date readout.

Note.png All format fields (date, time, currency, numeric) are formatted automatically in the selected format as soon as you leave them regardless of how you entered the input.

Spin Button

Numerical fields, currency fields, date and time fields can be introduced as spin buttons in the form.

Tristate

Specifies whether a check box can also represent ZERO values of a linked database apart from the TRUE and FALSE values. This function is only available if the database accepts three states: TRUE, FALSE and ZERO.

Note.png The Tristate property is only defined for database forms, not for HTML forms.

Printable

Specifies whether you want the control field to appear in a document's printout.

Row height

In table controls, enter a value for the row height. If you want, you can enter a value followed by valid measurement unit, for example, 2 cm.

Edit mask

By specifying the character code in pattern fields, you can determine what the user can enter in the pattern field.

The length of the edit mask determines the number of the possible input positions. If the user enters characters that do not correspond to the edit mask, the input is rejected when the user leaves the field. You can enter the following characters to define the edit mask:

Character Meaning
L A text constant. This position cannot be edited. The character is displayed at the corresponding position of the Literal Mask.
a The characters a-z and A-Z can be entered. Capital characters are not converted to lowercase characters.
A The characters A-Z can be entered. If a lowercase letter is entered, it is automatically converted to a capital letter
c The characters a-z, A-Z, and 0-9 can be entered. Capital characters are not converted to lowercase characters.
C The characters A-Z and 0-9 can be entered. If a lowercase letter is entered, it is automatically converted to a capital letter
N Only the characters 0-9 can be entered.
x All printable characters can be entered.
X All printable characters can be entered. If a lowercase letter is used, it is automatically converted to a capital letter.

For the literal mask "__.__.2000", for example, define the "NNLNNLLLLL" edit mask so that the user can only enter four digits when entering a date.

Strict format

You can have a format check with control fields that accept formatted contents (date, time, and so on). If the strict format function is activated (Yes), only the allowed characters are accepted. For example, in a date field, only numbers or date delimiters are accepted; all alphabet entries typed with your keyboard are ignored.

Word break

Displays text on more than one line. Allows you to use line breaks in a text box, so that you can enter more than one line of text. To manually enter a line break, press the Enter key.

Graphics

An image button has a Graphics property. The Graphics property specifies the graphic's path and file name that you want to have displayed on the button. If you select the graphic file with the ... button, the path and file name will be automatically included in the text box.

Default scroll value

Sets the default value for the scrollbar.

Help text

Provides the option of entering a help text that will be displayed as a tip on the control. The tip shows the text in user mode when the mouse is moved over the control.

For URL type buttons, the help text appears as the extended tip instead of the URL address entered under URL.

Help URL

Specifies a batch label in URL spelling which refers to a help document and which can be called with the help of the control field. The help for the control field help can be opened if the focus is positioned on the control field and the user presses F1.

Background color

A background color is available for most control fields. If you click on Background color, a list will open which enables you to select among various colors. The "Standard" option adopts the system setting. If the desired color is not listed, click the ... button to define a color in the Color dialog.

Scrollbar

Adds the scrollbar type that you specify to a text box.

Value step

You can preset the value intervals for numerical and currency spin buttons. Use the up and down arrows of the spin button to increase or decrease the value.

Time format

You can define the desired format for the time display.

List entries

Please note the tips referring to the keyboard controls.

The predefined default list entry is entered into the Default selection combo box.

Note.png Note that the list entries entered here are only incorporated into the form if, on the Data tab under List Content Type, the option "Value List" is selected.

If you do not want the list entries to be written to the database or transmitted to the recipient of the Web form, but rather assigned values that are not visible in the form, you can assign the list entries to other values in a value list. The value list is determined on the Data tab. Under Type of List Contents, select the option "Value List". Then enter the values under List Contents that are to be assigned to the corresponding visible list entries of the form. For the correct assignment, the order in the value list is relevant.

Note.png For HTML documents, a list entry entered on the General tab corresponds to the HTML tag <OPTION>; an entry of the value list entered on the Data tab under List Contents corresponds to the <OPTION VALUE=...> tag.

Date max

Determines a date which can not be exceeded by another value introduced by the user.

Max text length

For text and combo boxes, you can define the maximum number of characters that the user can enter. If this control field property is uncertain, the default setting will be zero.

If the control is linked to a database and the text length is to be accepted from the field definition of the database, you must not enter the text length here. The settings are only accepted from the database if the control property was not defined ("Not Defined" state).

Value max

For numerical and currency fields, you can determine the maximum value that the user can enter.

Time max

Determines a time which can not be exceeded by another value introduced by the user.

Multiselection

Allows you to select more than one item in a list box.

Text type

Allows you to use line breaks and formatting in a control field, such as a text box or label. To manually enter a line break, press the Enter key. Select "Multi-line with formatting" to enter formatted text.

Warning.png If you select the text type "Multi-line with formatting", you cannot bind this control to a database field.
Note.png This control is named "Multiline input" for a text column inside a table control.

Date min

Determines the earliest date that a user can enter.

Value min

For numerical and currency fields you can determine a minimum value to prevent the user from entering a smaller value.

Time min

Determines the minimum time that a user can enter.

Help text

In each control field you can specify additional information or a descriptive text for the control field. This property helps the programmer to save additional information that can be used in the program code. This field can be used, for example, for variables or other evaluation parameters.

Decimal accuracy

With numerical and currency fields you can determine the number of digits displayed to the right of the decimal point.

Name

Each control field and each form has a Name property through which it can be identified. The name will appear in the Form Navigator and, using the name, the control field can be referred to from a macro. The default settings already specify a name which is constructed from using the field's label and number.

Note.png If you work with macros, make sure that the names of the controls are unique.

The name is also used to group different controls that belong together functionally, such as radio buttons. To do so, give the same name to all members of the group: controls with identical names form a group. Grouped controls can be represented visually by using a Group Box.

Navigation bar

Specifies whether to display the navigation bar on the lower border of table controls.

Read-only

The Read-only property can be assigned to all controls in which the user can enter text. If you assign the read-only property to an image field which uses graphics from a database, the user will not be able to insert new graphics into the database.

Border

With control fields that have a frame, you can determine the border display on the form using the Border property. You can select among the "Without frame", "3-D look" or "Flat" options.

Tab order

The Tab order property determines the order in which the controls are focused in the form when you press the Tab key. In a form that contains more than one control, the focus moves to the next control when you press the Tab key. You can specify the order in which the focus changes with an index under Tab order.

Note.png The Tab order property is not available to Hidden Controls. If you want, you can also set this property for image buttons and image controls, so that you can select these controls with the Tab key.

When creating a form, an index is automatically assigned to the control fields that are added to this form; every control field added is assigned an index increased by 1. If you change the index of a control, the indices of the other controls are updated automatically. Elements that cannot be focused (Tabstop = No) are also assigned a value. However, these controls are skipped when using the Tab key.

You can also easily define the indices of the different controls in the Tab Order dialog.

Acting on a record

Specifies to show or hide the action items in a selected Navigation Bar control. Action items are the following: Save record, Undo, New record, Delete record, Refresh.

Default status

Specifies whether an option or a check box is selected by default.

For a reset type button, you can define the status of the control if the reset button is activated by the user.

For grouped option fields, the status of the group corresponding to the default setting is defined by the Default Status property.

Default selection

Specifies the list box entry to mark as the default entry.

For a Reset type button, the Default selection entry defines the status of the list box if the reset button is activated by the user.

For a List box that contains a value list, you can click the ... button to open the Default selection dialog.

In the Default selection dialog, select the entries that you want to mark as selected when you open the form that contains the list box.

Default value

Sets the default value for the control field. For example, the default value will be entered when a form is opened.

For a Reset type button, the Default value entry defines the status of the control if the reset button is activated by the user.

Formatting

Specifies the format code for the control. Click the ... button to select the format code.

Default time

Sets the default time.

Default date

Sets the default date.

Default text

Sets the default text for a text box or a combo box.

Default button

The Default button property specifies that the corresponding button will be operated when you press the Return key. If you open the dialog or form and do not carry out any further action, the button with this property is the default button.

Note.png This property should be assigned only to a single button within the document.

When using Web page forms, you might come across this property in search masks. These are edit masks that contain a text field and a Submit type button. The search term is entered in the text field and the search is started by activating the button. If the button is defined as the default button, however, simply hit Enter after entering the search term in order to start the search.

Prefix symbol

Determines if the currency symbol is displayed before or after the number when using currency fields. The default setting is currency symbols are not prefixed.

Tabstop

The Tabstop property determines if a control field can be selected with the tab key. The following options are available:

No When using the tab key, focusing skips the control.
Yes The control can be selected with the Tab key.

Thousands separator

With numerical and currency fields you can determine whether thousands separators are used.

Label

The Label property sets the label of the control field that is displayed in the form. This property determines the visible label or the column header of the data field in table control forms.

When you create a new control, the description predefined in the Name property is used as the default for labeling the control. The label consists of the control field name and an integer numbering the control (for example, CommandButton1). With the Title property, you can assign another description to the control so that the label reflects the function of the control. Change this entry in order to assign an expressive label to the control that is visible to the user.

To create a multi-line title, open the combo box using the arrow button. You can enter a line break by pressing Shift+Ctrl+Enter.

Note.png The Title property is only used for labeling a form element in the interface visible to the user. If you work with macros, note that at runtime, a control is always addressed through the Name property.

URL

Enter the URL address for a Open document or web page button type in the URL box. The address opens when you click the button.

If you move the mouse over the button in User mode, the URL appears as the extended tip, provided that no other Help text was entered.

Currency symbol

In a currency field, you can pre-define the currency symbol by entering the character or string in the Currency symbol property.

Enabled

If a control field has the property "Enabled" (Yes), the form user will be able to use the control field. If the property is disabled, it will not be enabled (No) and will be displayed in a gray color.