Skip to main content

ApiDropCap

Class representing a drop cap. A drop cap is a large initial letter that is split off from a paragraph into a separate framed paragraph.

Methods​

The following table lists the available methods.

MethodReturnsDescription
ClearbooleanRemoves the drop cap, merging the drop cap letter back into the paragraph text.
GetClassType"dropCap"Returns the type of the ApiDropCap class.
GetDistanceFromTexttwipsReturns the distance between the drop cap and the paragraph text measured in twentieths of a point (1/1440 of an inch).
GetLinesToDropnumberReturns the number of lines that the drop cap occupies.
GetParentApiParagraphReturns the paragraph this drop cap was requested from: either the framed drop cap paragraph itself, or the paragraph that continues its text.
GetPosition"none" | "drop" | "margin"Returns the drop cap type.
SetDistanceFromTextApiDropCapSets the distance between the drop cap and the paragraph text measured in twentieths of a point (1/1440 of an inch).
SetFontFamilyApiDropCapSets the font family of the drop cap letter.
SetLinesToDropApiDropCapSets the number of lines that the drop cap occupies. The drop cap letter is resized accordingly.
SetPositionApiDropCap | null | undefinedSets the drop cap type.