Edit.property

Description

Settings that affect the appearance and behavior of columns whose edit style is Edit.

Applies to

Column controls

Syntax

DataWindow .NET dot notation:

(( SimpleEdit) colname.EditStyle).property [C#]
CType(colname.EditStyle, SimpleEdit).property [Visual Basic]

Describe and Modify argument:

"columnname.Edit.property { = value }"

DataWindowSyntaxFromSql:

Column ( Edit.property = value )

Parameter	Description
columnname	The column with the Edit edit style for which you want to get or set property values. You can specify the column name or a pound sign (#) and the column number.
property	A property for the column’s Edit style. Properties and their settings are listed in the table below. The table identifies the properties you can use with DataWindowSyntaxFromSql.
value	The value to be assigned to the property. For most Edit properties, you cannot specify a DataWindow expression. The exception is Edit.Format.

Property for Edit	Value
AutoHScroll	Whether the edit control scrolls horizontally automatically when data is entered or deleted. Values are: Yes – Scroll horizontally automatically. No – Do not scroll horizontally automatically. You can use AutoHScroll with DataWindowSyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Auto Horz Scroll option.
AutoSelect	Whether to select the contents of the edit control automatically when it receives focus. Values are: Yes – Select automatically. No – Do not select automatically. You can use AutoSelect with DataWindowSyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Auto Selection option.
AutoVScroll	Whether the edit box scrolls vertically automatically when data is entered or deleted. Values are: Yes – Scroll vertically automatically. No – Do not scroll vertically automatically. You can use AutoVScroll with DataWindowSyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Auto Vert Scroll option.
Case	The case of the text in the edit control. Values are: Any – Character of any case allowed. Upper – Characters converted to uppercase. Lower – Characters converted to lowercase. Painter: Case option.
CodeTable	Whether the column has a code table. Values are: Yes – Code table defined. No – No code table defined. Painter: Use Code Table option.
DisplayOnly	Whether the column is display only. Values are: Yes – Do not allow the user to enter data; make the column display only. No – (Default) Allow the user to enter data. Painter: Display Only option. For conditional control over column editing, use the Protect property.
FocusRectangle	Whether a dotted rectangle (the focus rectangle) will surround the current row of the column when the column has focus. Values are: Yes – (Default) Display the focus rectangle. No – Do not display the focus rectangle. You can use FocusRectangle with DataWindowSyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Show Focus Rectangle option.
Format	(exp) A string containing the display format of the edit control. The value for Format is quoted and can be a DataWindow expression. Painter: Format option (do not use quotes around the value).
HScrollBar	Whether a horizontal scroll bar displays in the edit control. Values are: Yes – Display the horizontal scroll bar. No – Do not display the horizontal scroll bar. Painter: Horz Scroll Bar option.
Limit	A number specifying the maximum number of characters (0 to 32,767) that the user can enter. 0 means unlimited. Painter: Limit option.
Name	A string whose value is the name of the predefined edit style associated with the column. Named styles are defined in the Database painter and can be reused. Specifying a name that has not been previously defined associates the name with the column but does not define a new edit style. Painter: Style Name option.
NilIsNull	Whether to set the value of the edit control to null when the user leaves it blank. Values are: Yes – Make the Empty string null. No – Do not make the empty string null. Painter: Empty String is Null option.
Password	Whether to assign secure display mode to the column. When the user enters characters, they display as asterisks (). Values are: Yes – Assign secure display mode to the column. No – Do not assign secure-display mode to the column. If you change the Password property, you should also change the Format property to display the results you want (for example, ****). Painter: Password option.
Required	Whether the column is required. Values are: Yes – It is required. No – It is not required. Painter: Required option.
Style	(Describe only) Returns the edit style of the column. Painter: Style Type option.
ValidateCode	Whether the code table will be used to validate user-entered values. Values are: Yes – Use the code table. No – Do not use the code table. Painter: Validate option, available when Use Code Table is selected.
VScrollBar	Whether a vertical scroll bar displays in the line edit. Values are: Yes – Display vertical scroll bars. No – Do not display vertical scroll bars. Painter: Vert Scroll Bar option.

Usage

In the painter

Select the control and set values in the Properties view, Edit tab, when Style Type is Edit.

In DataWindow .NET, you can use the SimpleEdit class to set Edit style properties using dot notation. See the description of the SimpleEdit class in the online Help in Visual Studio .NET for a complete list of properties. Some properties have different names and are set differently. For example, the Case DataWindow object property is equivalent to the CharacterCasing property in DataWindow .NET, which uses an enumeration.

Examples

Example 1

[Visual Basic]
dw_1.emp_name.Edit.Required = false

Example 2

setting = dw_1.Describe("emp_name.Edit.AutoHScroll")

dw_1.Modify("emp_name.Edit.Required=no")