Word.CustomProperty class

Represents a custom property.

[ API set: WordApi 1.3 ]

Extends
OfficeExtension.ClientObject

Properties

key

Gets the key of the custom property. Read only.

[ API set: WordApi 1.3 ]

type

Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. Read only.

[ API set: WordApi 1.3 ]

value

Gets or sets the value of the custom property. Note that even though Word Online 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 ]

Methods

delete()

Deletes the custom property.

[ API set: WordApi 1.3 ]

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()
track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.

untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.

Property Details

key

Gets the key of the custom property. Read only.

[ API set: WordApi 1.3 ]

readonly key: string;
Property Value
string

type

Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. Read only.

[ API set: WordApi 1.3 ]

readonly type: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean";
Property Value
Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"

value

Gets or sets the value of the custom property. Note that even though Word Online 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: any;
Property Value
any

Method Details

delete()

Deletes the custom property.

[ API set: WordApi 1.3 ]

delete(): void;
Returns
void

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Word.CustomProperty;
Parameters
option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns
Word.CustomProperty
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Word.CustomProperty - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Word.CustomProperty - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

toJSON()

toJSON(): Word.Interfaces.CustomPropertyData;
Returns
Word.Interfaces.CustomPropertyData

track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.

track(): Word.CustomProperty;
Returns
Word.CustomProperty

untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.

untrack(): Word.CustomProperty;
Returns
Word.CustomProperty