IFormField

public interface IFormField

Represents a form field.

Methods

Method Description
getStylesheet() Gets the stylesheet applied to the form field.
getReadonly() Gets or sets a value indicating whether this IFormField is readonly.
setReadonly(boolean value) Gets or sets a value indicating whether this IFormField is readonly.
getName() Gets the name of the form field.
getType() Gets the type of the form field.
getLocaleId() Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.
setLocaleId(int value) Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.
getStatusText() Gets or sets the status text associated with the form field, the source of the text that’s displayed in the status bar when a form field has the focus.
setStatusText(HelpText value) Gets or sets the status text associated with the form field, the source of the text that’s displayed in the status bar when a form field has the focus.
getHelpText() Gets or sets the help text associated with the form field, the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.
setHelpText(HelpText value) Gets or sets the help text associated with the form field, the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.

getStylesheet()

public abstract String getStylesheet()

Gets the stylesheet applied to the form field.

Value: The stylesheet.

Returns: java.lang.String

getReadonly()

public abstract boolean getReadonly()

Gets or sets a value indicating whether this IFormField is readonly. Some analog of HTML attribute: readonly .

Value: true if readonly; otherwise, false .

Returns: boolean

setReadonly(boolean value)

public abstract void setReadonly(boolean value)

Gets or sets a value indicating whether this IFormField is readonly. Some analog of HTML attribute: readonly .

Value: true if readonly; otherwise, false .

Parameters:

Parameter Type Description
value boolean

getName()

public abstract String getName()

Gets the name of the form field.

Returns: java.lang.String

getType()

public abstract int getType()

Gets the type of the form field.

Returns: int

getLocaleId()

public abstract int getLocaleId()

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.


The following example demonstrates how to set the LocaleId property:
 
 Set the LocaleId to represent the English (United States) culture
 field.LocaleId = new CultureInfo("en-US").LCID;

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

Returns: int

setLocaleId(int value)

public abstract void setLocaleId(int value)

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.


The following example demonstrates how to set the LocaleId property:
 
 Set the LocaleId to represent the English (United States) culture
 field.LocaleId = new CultureInfo("en-US").LCID;

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

Parameters:

Parameter Type Description
value int

getStatusText()

public abstract HelpText getStatusText()

Gets or sets the status text associated with the form field, the source of the text that’s displayed in the status bar when a form field has the focus.


If set to false , the status text will not be applied.

Returns: HelpText

setStatusText(HelpText value)

public abstract void setStatusText(HelpText value)

Gets or sets the status text associated with the form field, the source of the text that’s displayed in the status bar when a form field has the focus.


If set to false , the status text will not be applied.

Parameters:

Parameter Type Description
value HelpText

getHelpText()

public abstract HelpText getHelpText()

Gets or sets the help text associated with the form field, the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.


If set to false , the help text will not be applied.

Returns: HelpText

setHelpText(HelpText value)

public abstract void setHelpText(HelpText value)

Gets or sets the help text associated with the form field, the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.


If set to false , the help text will not be applied.

Parameters:

Parameter Type Description
value HelpText