CustomProperty Object (JavaScript API for Word)

Word 2016, Word for iPad, Word for Mac, Word Online

Represents a custom property.

Properties

Property Type Description Req. Set
key string Gets the key of the custom property. Read only. Read-only. 1.3
type string Gets the value type of the custom property. Read only. Read-only. Possible values are: String, Number, Date, Boolean. 1.3
value object Gets or sets the value of the custom property. 1.3

See property access examples.

Relationships

None

Methods

Method Return Type Description Req. Set
delete() void Deletes the custom property. 1.3
load(param: object) void Fills the proxy object created in JavaScript layer with property and object values specified in the parameter. 1.1

Method Details

delete()

Deletes the custom property.

Syntax

customPropertyObject.delete();

Parameters

None

Returns

void

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter Type Description
param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.

Returns

void