Word.TabStop class
Represents a tab stop in a Word document.
- Extends
Remarks
Properties
| alignment | Gets a |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| custom |
Gets whether this tab stop is a custom tab stop. |
| leader | Gets a |
| next | Gets the next tab stop in the collection. |
| position | Gets the position of the tab stop relative to the left margin. |
| previous | Gets the previous tab stop in the collection. |
Methods
| clear() | Removes this custom tab stop. |
| 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
alignment
Gets a TabAlignment value that represents the alignment for the tab stop.
readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List";Property Value
Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"
Remarks
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
customTab
Gets whether this tab stop is a custom tab stop.
readonly customTab: boolean;Property Value
boolean
Remarks
leader
Gets a TabLeader value that represents the leader for this TabStop object.
readonly leader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";Property Value
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Remarks
next
Gets the next tab stop in the collection.
readonly next: Word.TabStop;Property Value
Remarks
position
Gets the position of the tab stop relative to the left margin.
readonly position: number;Property Value
number
Remarks
previous
Gets the previous tab stop in the collection.
readonly previous: Word.TabStop;Property Value
Remarks
Method Details
clear()
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.TabStopLoadOptions): Word.TabStop;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.TabStop;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.TabStop;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.TabStop object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.TabStopData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.TabStopData;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.TabStop;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.TabStop;