Word.Interfaces.CustomPropertyCollectionLoadOptions interface

Contains the collection of Word.CustomProperty objects.

[ API set: WordApi 1.3 ]

Properties

$all
key

For EACH ITEM in the collection: Gets the key of the custom property. Read only.

[ API set: WordApi 1.3 ]

type

For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. Read only.

[ API set: WordApi 1.3 ]

value

For EACH ITEM in the collection: Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair).

[ API set: WordApi 1.3 ]

Property Details

$all

$all?: boolean;

Property Value

boolean

key

For EACH ITEM in the collection: Gets the key of the custom property. Read only.

[ API set: WordApi 1.3 ]

key?: boolean;

Property Value

boolean

type

For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. Read only.

[ API set: WordApi 1.3 ]

type?: boolean;

Property Value

boolean

value

For EACH ITEM in the collection: Gets or sets the value of the custom property. Note that even though Word for the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair).

[ API set: WordApi 1.3 ]

value?: boolean;

Property Value

boolean