Word.DropCap class
Represents a dropped capital letter in a Word document.
- 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. |
| distance |
Gets the distance (in points) between the dropped capital letter and the paragraph text. |
| font |
Gets the name of the font for the dropped capital letter. |
| lines |
Gets the height (in lines) of the dropped capital letter. |
| position | Gets the position of the dropped capital letter. |
Methods
| clear() | Removes the dropped capital letter formatting. |
| enable() | Formats the first character in the specified paragraph as a dropped capital letter. |
| 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
distanceFromText
Gets the distance (in points) between the dropped capital letter and the paragraph text.
readonly distanceFromText: number;Property Value
number
Remarks
fontName
Gets the name of the font for the dropped capital letter.
readonly fontName: string;Property Value
string
Remarks
linesToDrop
Gets the height (in lines) of the dropped capital letter.
readonly linesToDrop: number;Property Value
number
Remarks
position
Gets the position of the dropped capital letter.
readonly position: Word.DropPosition | "None" | "Normal" | "Margin";Property Value
Word.DropPosition | "None" | "Normal" | "Margin"
Remarks
Method Details
clear()
Removes the dropped capital letter formatting.
clear(): void;Returns
void
Remarks
enable()
Formats the first character in the specified paragraph as a dropped capital letter.
enable(): void;Returns
void
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.DropCapLoadOptions): Word.DropCap;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.DropCap;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.DropCap;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.DropCap object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.DropCapData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.DropCapData;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.DropCap;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.DropCap;