Word.HtmlDivision class
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| html |
|
| left |
Specifies the left indent value (in points) for this HTML division. |
| range | Gets a |
| right |
Specifies the right indent (in points) for this HTML division. |
| space |
Specifies the amount of spacing (in points) after this HTML division. |
| space |
Specifies the spacing (in points) before this HTML division. |
Methods
| delete() | Deletes this HTML division. |
| html |
Returns an |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
| 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're using this object across |
| 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'll need to call |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
htmlDivisions
leftIndent
Specifies the left indent value (in points) for this HTML division.
leftIndent: number;Property Value
number
Remarks
range
Gets a Range object that represents the portion of a document that's contained in this HTML division.
readonly range: Word.Range;Property Value
Remarks
rightIndent
Specifies the right indent (in points) for this HTML division.
rightIndent: number;Property Value
number
Remarks
spaceAfter
Specifies the amount of spacing (in points) after this HTML division.
spaceAfter: number;Property Value
number
Remarks
spaceBefore
Specifies the spacing (in points) before this HTML division.
spaceBefore: number;Property Value
number
Remarks
Method Details
delete()
htmlDivisionParent(levelsUp)
Returns an HtmlDivision object that represents a parent division of the current HTML division.
htmlDivisionParent(levelsUp?: number): Word.HtmlDivision;Parameters
- levelsUp
-
number
Optional. The number of levels to go up to retrieve the parent division.
Returns
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.HtmlDivisionLoadOptions): Word.HtmlDivision;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.HtmlDivision;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.HtmlDivision;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.HtmlDivision object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.HtmlDivisionData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.HtmlDivisionData;Returns
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're 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 need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.HtmlDivision;Returns
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'll need to call context.sync() before the memory release takes effect.
untrack(): Word.HtmlDivision;