Word.Interfaces.CustomPropertyLoadOptions interface
Represents a custom property.
$all | Specifying |
key | Gets the key of the custom property. |
type | Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. |
value | 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). |
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
Gets the key of the custom property.
key?: boolean;
Property Value
boolean
Remarks
Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean.
type?: boolean;
Property Value
boolean
Remarks
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
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: