A property definition describes a particular value of a business entity. Business entities are transacted as records, therefore properties and lists of properties are referred to as fields and records. Moreover, a list of property definitions is referred to as a record definition and is the metadata describing the read/write capabilities of a specific dialog model in use by a specific user in a specific workflow. Contains information that 'defines' a property Property (name/value) An instance of the Property contains the actual data value.

### Hierarchy

- PropertyDef

## Index

### Constructors

- constructor

### Properties

- canCauseSideEffects
- contentType
- displayLength
- displayScale
- format
- length
- propertyName
- propertyType
- scale
- semanticType
- upperCaseOnly
- writeAllowed
- writeEnabled

### Accessors

- isBarcodeType
- isBooleanType
- isByteFormat
- isCodeRefType
- isDateTimeType
- isDateType
- isDecimalType
- isDoubleType
- isEmailType
- isFileAttachment
- isFloatType
- isGpsReadingType
- isHTMLType
- isInlineMediaStyle
- isIntType
- isLargePropertyType
- isListType
- isLongType
- isMapLocationType
- isMoneyType
- isNameType
- isNumericType
- isObjRefType
- isPasswordType
- isPercentType
- isReadOnly
- isSignatureType
- isStringType
- isTelephoneType
- isTextBlock
- isTimeType
- isURLType
- isUnformattedNumericType
- isWritable

## Constructors

### constructor

- new PropertyDef(canCauseSideEffects: boolean, contentType: string, displayLength: number, displayScale: number, format: string, length: number, propertyName: string, propertyType: string, scale: number, semanticType: string, upperCaseOnly: boolean, writeAllowed: boolean, writeEnabled: boolean): PropertyDef

- - Defined in models/PropertyDef.ts:13

  #### Parameters

  - ##### canCauseSideEffects: boolean

  - ##### contentType: string

  - ##### displayLength: number

  - ##### displayScale: number

  - ##### format: string

  - ##### length: number

  - ##### propertyName: string

  - ##### propertyType: string

  - ##### scale: number

  - ##### semanticType: string

  - ##### upperCaseOnly: boolean

  - ##### writeAllowed: boolean

  - ##### writeEnabled: boolean

  #### Returns PropertyDef

## Properties

### canCauseSideEffects

canCauseSideEffects: boolean

- Defined in models/PropertyDef.ts:15

### contentType

contentType: string

- Defined in models/PropertyDef.ts:16

### displayLength

displayLength: number

- Defined in models/PropertyDef.ts:17

### displayScale

displayScale: number

- Defined in models/PropertyDef.ts:18

### format

format: string

- Defined in models/PropertyDef.ts:19

### length

length: number

- Defined in models/PropertyDef.ts:20

### propertyName

propertyName: string

- Defined in models/PropertyDef.ts:21

### propertyType

propertyType: string

- Defined in models/PropertyDef.ts:22

### scale

scale: number

- Defined in models/PropertyDef.ts:23

### semanticType

semanticType: string

- Defined in models/PropertyDef.ts:24

### upperCaseOnly

upperCaseOnly: boolean

- Defined in models/PropertyDef.ts:25

### writeAllowed

writeAllowed: boolean

- Defined in models/PropertyDef.ts:26

### writeEnabled

writeEnabled: boolean

- Defined in models/PropertyDef.ts:27

## Accessors

### isBarcodeType

- get isBarcodeType(): boolean

- - Defined in models/PropertyDef.ts:30

  #### Returns boolean

### isBooleanType

- get isBooleanType(): boolean

- - Defined in models/PropertyDef.ts:38

  #### Returns boolean

### isByteFormat

- get isByteFormat(): boolean

- - Defined in models/PropertyDef.ts:34

  #### Returns boolean

### isCodeRefType

- get isCodeRefType(): boolean

- - Defined in models/PropertyDef.ts:42

  #### Returns boolean

### isDateTimeType

- get isDateTimeType(): boolean

- - Defined in models/PropertyDef.ts:50

  #### Returns boolean

### isDateType

- get isDateType(): boolean

- - Defined in models/PropertyDef.ts:46

  #### Returns boolean

### isDecimalType

- get isDecimalType(): boolean

- - Defined in models/PropertyDef.ts:54

  #### Returns boolean

### isDoubleType

- get isDoubleType(): boolean

- - Defined in models/PropertyDef.ts:58

  #### Returns boolean

### isEmailType

- get isEmailType(): boolean

- - Defined in models/PropertyDef.ts:62

  #### Returns boolean

### isFileAttachment

- get isFileAttachment(): boolean

- - Defined in models/PropertyDef.ts:66

  #### Returns boolean

### isFloatType

- get isFloatType(): boolean

- - Defined in models/PropertyDef.ts:70

  #### Returns boolean

### isGpsReadingType

- get isGpsReadingType(): boolean

- - Defined in models/PropertyDef.ts:74

  #### Returns boolean

### isHTMLType

- get isHTMLType(): boolean

- - Defined in models/PropertyDef.ts:82

  #### Returns boolean

### isInlineMediaStyle

- get isInlineMediaStyle(): boolean

- - Defined in models/PropertyDef.ts:87

  #### Returns boolean

### isIntType

- get isIntType(): boolean

- - Defined in models/PropertyDef.ts:97

  #### Returns boolean

### isLargePropertyType

- get isLargePropertyType(): boolean

- - Defined in models/PropertyDef.ts:117

  #### Returns boolean

### isListType

- get isListType(): boolean

- - Defined in models/PropertyDef.ts:93

  #### Returns boolean

### isLongType

- get isLongType(): boolean

- - Defined in models/PropertyDef.ts:101

  #### Returns boolean

### isMapLocationType

- get isMapLocationType(): boolean

- - Defined in models/PropertyDef.ts:78

  #### Returns boolean

### isMoneyType

- get isMoneyType(): boolean

- - Defined in models/PropertyDef.ts:105

  #### Returns boolean

### isNameType

- get isNameType(): boolean

- - Defined in models/PropertyDef.ts:109

  #### Returns boolean

### isNumericType

- get isNumericType(): boolean

- - Defined in models/PropertyDef.ts:113

  #### Returns boolean

### isObjRefType

- get isObjRefType(): boolean

- - Defined in models/PropertyDef.ts:121

  #### Returns boolean

### isPasswordType

- get isPasswordType(): boolean

- - Defined in models/PropertyDef.ts:125

  #### Returns boolean

### isPercentType

- get isPercentType(): boolean

- - Defined in models/PropertyDef.ts:129

  #### Returns boolean

### isReadOnly

- get isReadOnly(): boolean

- - Defined in models/PropertyDef.ts:133

  #### Returns boolean

### isSignatureType

- get isSignatureType(): boolean

- - Defined in models/PropertyDef.ts:141

  #### Returns boolean

### isStringType

- get isStringType(): boolean

- - Defined in models/PropertyDef.ts:145

  #### Returns boolean

### isTelephoneType

- get isTelephoneType(): boolean

- - Defined in models/PropertyDef.ts:149

  #### Returns boolean

### isTextBlock

- get isTextBlock(): boolean

- - Defined in models/PropertyDef.ts:153

  #### Returns boolean

### isTimeType

- get isTimeType(): boolean

- - Defined in models/PropertyDef.ts:157

  #### Returns boolean

### isURLType

- get isURLType(): boolean

- - Defined in models/PropertyDef.ts:165

  #### Returns boolean

### isUnformattedNumericType

- get isUnformattedNumericType(): boolean

- - Defined in models/PropertyDef.ts:161

  #### Returns boolean

### isWritable

- get isWritable(): boolean

- - Defined in models/PropertyDef.ts:137

  #### Returns boolean

Generated using TypeDoc