Name (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage properties

Various properties

Name

Presentation

Example

Window alias

Tab pane name

Object type

Connection name

Limitations

See also

Name (Property)

In french: Nom

Not available with this kind of connection

The Name property is used to get:

the name of the font associated with a variable of type Font.
Remark: The font name must correspond to one of the fonts installed on the current computer.
the name of a control, report or report block.
the name of a control, group of controls or window.
the name of a control, group of controls or page.
The Name property is used to get the real name of a control generated in the page, i.e. the control alias. This property can only be used on the following types of controls: edit control, List Box, Combo Box, Check Box, Radio Button and Button.

The Name property is used to change the name of the font associated with a Font variable.

The Name property can also be used to handle the names of different HFSQL objects. You can:

Find out the name of a connection.
Find out the name of an object handled by indirection:
- data file defined in the data model editor or programmatically,
- view,
- query previously executed with HExecuteQuery,
- item defined in the data model editor or through programming,
- link defined in the data model editor or through programming.
Define the name of the described element:
- when a file is described through programming,
- when an item is described through programming,
- when a link is described through programming,
- when a full-text index is described through programming.

When used on the MyChildWindow keyword, the Name property gets the name of the last closed child window in a mobile application.

Example

// Define the characteristics of a Font variable
Font1 is Font
Font1.Name = "Arial"
Font1.Color = LightYellow
Font1.Size = 14
Font1.SizeUnit = unitPoint
Font1.Orientation = 45
// Apply the font to "MyControl"
MyControl.Font = Font1

AnItem1 is Item Description
...
// Declare the item 1
AnItem1.Name = "ITM1"
AnItem1.Type = hItemText
AnItem1.Size = 20
HDescribeItem(AFile, AnItem1)
...
HDescribeFile(AFile)
HCreation(Temp_File)

// Procedure to which a control name is passed as parameter
PROCEDURE MakeVisible(Control)
// Name of current control
IF {Control}..Name = "CustomerName" THEN
{Control}..Visible = True
END

Syntax

Finding out the name of specified element Hide the details

<Result> = <Element used>.Name

<Result>: Character string

Name of specified element.

<Element used>: Character string

Name of the element to be used.

Modifying the name of specified element Hide the details

<Element used>: Character string

Name of the dynamic object used:
file defined through programming via the File Description type,
item defined through programming via the Item Description type,
link defined through programming via the Link description type.
full-text index defined through programming via the FullTextIndex Description type.
or
Name of the Font variable to be used.

<New name>: Character string

New name for the specified element

Remarks

A font can be created from a Font variable.

To define the font characteristics, use:

the FontCreate function.
This function is not available.
the Charset, Orientation, StrikeOut, Color, Bold, Italic, CharacterSpacing, LineSpacing, Name, Underline, Size and SizeUnit properties.
Only the following properties can be used with the Font type: Orientation, StrikeOut, Color, Bold, Italic, Name, Underline, Size.
The Charset and Orientation properties are not available for Font variables.

This font can be used:

To write text in drawings (dFont).
To write in charts (grLabelFont, grLegendFont, grTitleFont and grAxisTitleFont).
To print (iFont).
In the controls of a window (Font property).
In the controls of a report (Font property).

This font can only be used in the controls of a window (Font property).

Window alias

The same window (child or sibling window) can be opened several times. To differentiate and identify the opened windows, an alias is assigned to each window.

To define an alias, use OpenSister or OpenChild. This alias is used to identify windows with functions that take a window name as a parameter (CurrentTitle, NextTitle, SetFocusAndReturnToUserInput, etc.) or to handle a control in a given window.

To get the alias of a window, use CurrentWin, PreviousWin or the Alias property.

If no alias is specified when the window is opened, an alias is automatically assigned to the window by WINDEV.

Tab pane name

The Name property returns the name of the tab pane. For example: Tab[2] for the second tab pane.

Object type

The Name property returns an empty string ("") for:

rows in the Table, List Box, ListView or Combo Box controls,
cells in Table controls.

Connection name

A connection can be created by a Connection variable. The name of the connection corresponds to the name of the variable.

If a connection with the same name already exists (in the analysis or described beforehand), the name of the connection is defined by the HFSQL engine that adds a suffix (a number) to the name of the variable.

In this case, the Name property returns the name of the connection defined by the HFSQL engine.

Finding out the name of the last child window that was closed
In the mobile applications, the windows are opened by OpenMobileWindow (or OpenChild) instead of Open.

You can get the name of the last closed child window in the "Close a child window" event of the window that opened it (the one that called OpenMobileWindow or OpenChild).

Simply use the Name property on the MyChildWindow keyword:

// Close a child window
NameChildWindow = MyChildWindow.Name

Remark: The ReturnedValue property is used to get the value returned by the child window when it is closed.

Limitations

The Name property cannot be used on:

an option in a Radio Button or Check Box control,
an element in a TreeView control.

The Name property can only be used in the following controls:

Edit control,
List Box control,
Combo Box control,
Check Box control,
Radio Button control,
Button control,
Group of controls.

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

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

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

Button control.
Static control.
Image control.
Window.