IFieldProperty (Step Enterprise 3.14.0 API)

All Superinterfaces:

com4j.Com4jObject

All Known Subinterfaces:

IFieldProperty2, IFieldProperty3, IFieldProperty4
```
public interface IFieldProperty
extends com4j.Com4jObject
```
Properties for a field.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`dbColumnName()` The database column name.
`String`	`dbColumnType()` The database column type.
`String`	`dbTableName()` The database table name.
`String`	`editMask()` The input mask for string fields.
`String`	`editStyle()` The user interface control type used to edit this field.
`int`	`fieldSize()` The size of the field in the database (-1 for BLOB fields).
`boolean`	`isActive()` Checks if the field is can be displayed in the user interface.
`boolean`	`isByCode()` Checks if the field saves the Tree Node ID (True), or the passed value (False).
`boolean`	`isCanFilter()` Checks if the field is displayed in the filter dialog box.
`boolean`	`isCustomizable()` Checks if the field is displayed in the customization UI.
`boolean`	`isEdit()` Checks if the field can be edited.
`boolean`	`isHistory()` Checks if change history is stored for the field.
`boolean`	`isKeepValue()` Checks if the last value for the field is stored.
`boolean`	`isKey()` Checks if this is a database key field.
`boolean`	`isMail()` Checks if e-mail is sent to the users on the notification list when this field changes.
`boolean`	`isModify()` Checks if the user currently logged on the TDConnection is permitted to modify this field.
`boolean`	`isRequired()` Checks if this is a required field.
`boolean`	`isSystem()` Checks if this is a predefined system field.
`boolean`	`isToSum()` Checks if this field is summed for graphs.
`boolean`	`isVerify()` Checks if the field requires verification.
`boolean`	`isVersionControl()` Checks if the field is under version control.
`boolean`	`isVisible()` For future use.
`boolean`	`isVisibleInNewBug()` Checks if the field is visible in the New Bug form.
`int`	`keyOrder()` Obsolete: The position of the field in multi-field database key (1-based).
`boolean`	`readOnly()` Checks if this is a read-only field.
`com4j.Com4jObject`	`root()` The tree root connected to the field.
`String`	`userColumnType()` The user column type: char, number, date, memo, or empty string.
`String`	`userLabel()` The user-defined label.

Methods inherited from interface com4j.Com4jObject
advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

- Method Detail
  - userLabel
```
String userLabel()
```
    The user-defined label.
    
    Getter method for the COM property "UserLabel"
    
    Returns:
    
    Returns a value of type java.lang.String
  - dbTableName
```
String dbTableName()
```
    The database table name.
    
    Getter method for the COM property "DBTableName"
    
    Returns:
    
    Returns a value of type java.lang.String
  - dbColumnName
```
String dbColumnName()
```
    The database column name.
    
    Getter method for the COM property "DBColumnName"
    
    Returns:
    
    Returns a value of type java.lang.String
  - dbColumnType
```
String dbColumnType()
```
    The database column type.
    
    Getter method for the COM property "DBColumnType"
    
    Returns:
    
    Returns a value of type java.lang.String
  - editStyle
```
String editStyle()
```
    The user interface control type used to edit this field.
    
    Getter method for the COM property "EditStyle"
    
    Returns:
    
    Returns a value of type java.lang.String
  - editMask
```
String editMask()
```
    The input mask for string fields.
    
    Getter method for the COM property "EditMask"
    
    Returns:
    
    Returns a value of type java.lang.String
  - isSystem
```
boolean isSystem()
```
    Checks if this is a predefined system field.
    
    Getter method for the COM property "IsSystem"
    
    Returns:
    
    Returns a value of type boolean
  - isCanFilter
```
boolean isCanFilter()
```
    Checks if the field is displayed in the filter dialog box.
    
    Getter method for the COM property "IsCanFilter"
    
    Returns:
    
    Returns a value of type boolean
  - isKey
```
boolean isKey()
```
    Checks if this is a database key field.
    
    Getter method for the COM property "IsKey"
    
    Returns:
    
    Returns a value of type boolean
  - keyOrder
```
int keyOrder()
```
    Obsolete: The position of the field in multi-field database key (1-based).
    
    Getter method for the COM property "KeyOrder"
    
    Returns:
    
    Returns a value of type int
  - isEdit
```
boolean isEdit()
```
    Checks if the field can be edited.
    
    Getter method for the COM property "IsEdit"
    
    Returns:
    
    Returns a value of type boolean
  - isActive
```
boolean isActive()
```
    Checks if the field is can be displayed in the user interface.
    
    Getter method for the COM property "IsActive"
    
    Returns:
    
    Returns a value of type boolean
  - isHistory
```
boolean isHistory()
```
    Checks if change history is stored for the field.
    
    Getter method for the COM property "IsHistory"
    
    Returns:
    
    Returns a value of type boolean
  - isMail
```
boolean isMail()
```
    Checks if e-mail is sent to the users on the notification list when this field changes.
    
    Getter method for the COM property "IsMail"
    
    Returns:
    
    Returns a value of type boolean
  - isVerify
```
boolean isVerify()
```
    Checks if the field requires verification.
    
    Getter method for the COM property "IsVerify"
    
    Returns:
    
    Returns a value of type boolean
  - root
```
com4j.Com4jObject root()
```
    The tree root connected to the field.
    
    Getter method for the COM property "Root"
    
    Returns:
    
    Returns a value of type com4j.Com4jObject
  - isByCode
```
boolean isByCode()
```
    Checks if the field saves the Tree Node ID (True), or the passed value (False).
    
    Getter method for the COM property "IsByCode"
    
    Returns:
    
    Returns a value of type boolean
  - isRequired
```
boolean isRequired()
```
    Checks if this is a required field.
    
    Getter method for the COM property "IsRequired"
    
    Returns:
    
    Returns a value of type boolean
  - userColumnType
```
String userColumnType()
```
    The user column type: char, number, date, memo, or empty string.
    
    Getter method for the COM property "UserColumnType"
    
    Returns:
    
    Returns a value of type java.lang.String
  - isKeepValue
```
boolean isKeepValue()
```
    Checks if the last value for the field is stored.
    
    Getter method for the COM property "IsKeepValue"
    
    Returns:
    
    Returns a value of type boolean
  - isCustomizable
```
boolean isCustomizable()
```
    Checks if the field is displayed in the customization UI.
    
    Getter method for the COM property "IsCustomizable"
    
    Returns:
    
    Returns a value of type boolean
  - fieldSize
```
int fieldSize()
```
    The size of the field in the database (-1 for BLOB fields).
    
    Getter method for the COM property "FieldSize"
    
    Returns:
    
    Returns a value of type int
  - isVisibleInNewBug
```
boolean isVisibleInNewBug()
```
    Checks if the field is visible in the New Bug form.
    
    Getter method for the COM property "IsVisibleInNewBug"
    
    Returns:
    
    Returns a value of type boolean
  - readOnly
```
boolean readOnly()
```
    Checks if this is a read-only field.
    
    Getter method for the COM property "ReadOnly"
    
    Returns:
    
    Returns a value of type boolean
  - isToSum
```
boolean isToSum()
```
    Checks if this field is summed for graphs.
    
    Getter method for the COM property "IsToSum"
    
    Returns:
    
    Returns a value of type boolean
  - isModify
```
boolean isModify()
```
    Checks if the user currently logged on the TDConnection is permitted to modify this field.
    
    Getter method for the COM property "IsModify"
    
    Returns:
    
    Returns a value of type boolean
  - isVersionControl
```
boolean isVersionControl()
```
    Checks if the field is under version control.
    
    Getter method for the COM property "IsVersionControl"
    
    Returns:
    
    Returns a value of type boolean
  - isVisible
```
boolean isVisible()
```
    For future use.
    
    Getter method for the COM property "IsVisible"
    
    Returns:
    
    Returns a value of type boolean

Interface IFieldProperty

Method Summary

Methods inherited from interface com4j.Com4jObject

Method Detail

userLabel

dbTableName

dbColumnName

dbColumnType

editStyle

editMask

isSystem

isCanFilter

isKey

keyOrder

isEdit

isActive

isHistory

isMail

isVerify

root

isByCode

isRequired

userColumnType

isKeepValue

isCustomizable

fieldSize

isVisibleInNewBug

readOnly

isToSum

isModify

isVersionControl

isVisible