Caption (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage properties

Various properties

Caption

Presentation

Example

Content of Static control

Equivalence

Caption associated with a window or with a page

Text of a Static, Edit, Combo Box, List Box or ListView control

Text of with a table column

Text of a Check Box or Radio Button control

Caption of a Check Box column in a Treeview Table control

Caption associated with an Image control

Caption associated with a button

Caption of a Tab control

Managing menus: Functions or properties?

Limitations

See also

Caption (Property)

In french: Libellé

In a database, the Caption property is used to:

Find out the caption associated with a file item.
Remark: The item was created in the data model editor or through programming.
Find out the caption associated with a data file.
Remark: The data file may have been created in the data model editor or through programming.
Find out and modify the connection caption. The connection can correspond to:
- a connection defined in the data model editor,
- a connection defined with HConnect, HDescribeConnection or HOpenConnection.
- a connection described by a Connection variable.

In a report, the Caption property is used to get and change the text:

of a Static control.
of a Link control.
of a Chart control.

In a window or page, the Caption property is also used to:

Find out and modify the caption of a control in a window or in a page.
Find out and modify the caption of a menu option.
Find out and modify the title of a window or page.

Reminder: The initial caption of a control, window, page or menu option is defined in the editor during the object description.

Example

// Find out the caption associated with the Customer.Title item
ResCaption = Customer.Title.Caption

// Modify the text in the "STC_IntroControl" Static control
STC_IntroControl.Caption = "Hello" + Customer.FullName
// Equivalent to: STC_IntroControl.Caption = "Hello [%Customer.FullName%]"

// Change the button caption
IF WIN_Window1.Modified = True THEN
BTN_Add.Caption = "Save"
ELSE
BTN_Add.Caption = "Close"
END

Syntax

Finding out the caption associated with an item Hide the details

<Result> = <Data file>.<Item>.Caption

<Result>: Integer

Item caption.

<Data file>: Character string

Logical name of the data file used.

<Item>: Character string

Name of the item used.

Finding out the text of caption associated with an element Hide the details

<Result> = <Element used>.Caption

<Result>: Character string

Text displayed in the specified element.

<Element used>: Type of element

Name of the element to be used.

Modifying the text of caption associated with an element Hide the details

<Element used>.Caption = <New text>

<Element used>: Type of element

Name of element to use.

<New text>: Character string

New text displayed in the specified element.

Remarks

Content of Static control

To retrieve the value of a control or the value of an item in a Static control:

In the report editor: insert [%<Control name>%] or [%<Item name>%] directly into the caption of the control.
In programming: there are two possible syntaxes with the Caption property:
- use directly the [%<Control name>%] or [%<Item name>%] string in the string that corresponds to the caption. For example:
  
  STC_IntroControl.Caption = "Hello [%Customer.FullName%]"
- use the name of the control or the name of the item in the caption. For example:
  
  STC_IntroControl.Caption = "Hello" + Customer.FullName

Equivalence

The Caption and Value properties are equivalent.

To retrieve the text of a Static control, the following syntaxes are equivalent:

ResCaption = <Static control>.Caption

ResCaption = <Static control>.Value

ResCaption = <Static control>

To modify the text displayed in a Static control, the following syntaxes are equivalent:

<Name of Static control>.Caption = <New text>

<Name of Static control>.Value = <New text>

<Name of Static control> = <New text>

Caption associated with a window or with a page

The caption associated with a window or with a page corresponds to the title of the window or to the title of the page. This title is returned by the Title property.

Text of a Static, Edit, Combo Box, List Box or ListView control

The control caption corresponds to the text of caption.

In a Static control, this text is returned by the Value property.

Text of with a table column

The text of a table column corresponds to the column title and is returned by the Title property.

Text of a Check Box or Radio Button control

The Caption property is used to get and change:

the text of a Check Box or Radio Button control,
the text of an option in the Check Box or Radio Button control.

To modify the caption of an option found in a Check box or Radio Button control:

<Control name>[<Index>].Caption = <New caption>

For example:

RADIO_Radio_Button[2].Caption = "Option number 2"

To modify the caption associated with a Check box or Radio Button control:

<Control name>.Caption = <New caption>

For example:

RADIO_Radio_Button.Caption = "Age of participants"

To retrieve the caption of an option:

<Control>[Index].Caption

Caption of a Check Box column in a Treeview Table control

When used on a Check Box column in a TreeView Table control, the Caption property can be used to get and change the text displayed next to the check box.

Caption associated with an Image control

The Caption property returns or replaces the current image with the image passed as parameter.

The Caption property has the same effect as assigning the name of the image to the control (Control = Image_Name).

The Image control includes a caption: the Caption property is used to change this text. If the new caption does not correspond to a valid image, the caption of the Image control is modified.

Caption associated with a button

The Caption property can have two actions:

replace the image of the button (the name passed as parameter corresponds to an image file),
return or replace the button caption (the text passed as parameter is not an image file name).

For example:

// Modify the image of a graphic button
BTN_Button1.Caption = "Help.BMP"

// Modify the caption of a text button
BTN_Button1.Caption = "New caption"

Remark: If the specified text contains the & character, the letter that follows & is interpreted as the shortcut of the control.

Remark: The caption of a Button control can be in RTF or not ("RTF" checked in the "General" tab of the control description).

The caption may contain RTF tags when it is retrieved. To get the caption without the RTF tags, use RTFToText. For example:

MyCaption is string
MyCaption = RTFToText(BTN_Button.Caption)
In edit mode, the text associated with the caption of the control can be in RTF text or not. The Button control will adapt automatically.

Caption of a Tab control

The caption of a Tab control corresponds to the text of the button that is used to select the tab pane.

Managing menus: Functions or properties?

The menu options (in main menus or in popup menus) can be managed by the Menuxxx functions and by the corresponding properties.

The equivalence table is as follows:

Available functions	Equivalent properties

MenuUnmark MenuIsMarked MenuMark	Checked
MenuState	State
MenuInvisible	Visible
MenuSelectMinus	State
MenuSelectPlus	State
MenuLabel	Caption

Limitations

In a report, the Caption property can only be used on "Static" and "Link" controls.

In a window, the Caption property cannot be used on the following types of controls:

Spin
Scrollbar

The Caption property can be used on automatic calculation rows to modify the text of the calculation. For more details, see Programming automatic calculations in the columns of a Table control.

The Caption property can only be used with the following elements:

Button.
Static.
Edit control.
Image.
Check Box.
Radio Button.
List Box.
Combo Box.
TreeView.
Tab.
Window.
Table.
Table column.