Edit

Share via

Word.Interfaces.CustomPropertyCollectionLoadOptions interface

  • Reference
Package:
word

Contains the collection of Word.CustomProperty objects.

Remarks

[ API set: WordApi 1.3 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
key

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

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

For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on 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).

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

key

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

key?: boolean;

Property Value

boolean

Remarks

[ 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.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

value

For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on 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).

value?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]