ApiTextPr
Class representing the text properties.
Methods
| Name |
Description |
| GetClassType |
Returns a type of the ApiTextPr class. |
| SetBold |
Sets the bold property to the text character. |
| SetCaps |
Specifies that any lowercase characters in the text run are formatted for display only as their capital letter character equivalents. |
| SetColor |
Sets the text color to the current text run in the RGB format. |
| SetDoubleStrikeout |
Specifies that the contents of the run are displayed with two horizontal lines through each character displayed on the line. |
| SetFill |
Sets the text color to the current text run. |
| SetFontFamily |
Sets all 4 font slots with the specified font family. |
| SetFontSize |
Sets the font size to the characters of the current text run. |
| SetHighlight |
Specifies a highlighting color which is added to the text properties and applied as a background to the contents of the current run/range/paragraph. |
| SetItalic |
Sets the italic property to the text character. |
| SetLanguage |
Specifies the languages which will be used to check spelling and grammar (if requested) when processing
the contents of the text run. |
| SetOutLine |
Sets the text outline to the current text run. |
| SetPosition |
Specifies an amount by which text is raised or lowered for this run in relation to the default
baseline of the surrounding non-positioned text. |
| SetShd |
Specifies the shading applied to the contents of the current text run. |
| SetSmallCaps |
Specifies that all the small letter characters in the text run are formatted for display only as their capital
letter character equivalents which are two points smaller than the actual font size specified for this text. |
| SetSpacing |
Sets the text spacing measured in twentieths of a point. |
| SetStrikeout |
Specifies that the contents of the run are displayed with a single horizontal line through the center of the line. |
| SetStyle |
The text style base method.
This method is not used by itself, as it only forms the basis for the ApiRun#SetStyle method which sets
the selected or created style to the text. |
| SetTextFill |
Sets the text fill to the current text run. |
| SetUnderline |
Specifies that the contents of the run are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line). |
| SetVertAlign |
Specifies the alignment which will be applied to the contents of the run in relation to the default appearance of the run text:
- "baseline" - the characters in the current text run will be aligned by the default text baseline.
- "subscript" - the characters in the current text run will be aligned below the default text baseline.
- "superscript" - the characters in the current text run will be aligned above the default text baseline.
|
| ToJSON |
Converts the ApiTextPr object into the JSON object. |
Example
Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTextPr = oDocument.GetDefaultTextPr();
oTextPr.SetFontSize(30);
oTextPr.SetBold(true);
oTextPr.SetCaps(true);
oTextPr.SetColor(255, 111, 61, false);
oTextPr.SetDoubleStrikeout(true);
oTextPr.SetFontFamily("Comic Sans MS");
oTextPr.SetHighlight(128, 128, 128, false);
oTextPr.SetItalic(true);
oTextPr.SetSpacing(80);
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("This is a sample text to show the specified text properties.");
var sClassType = oTextPr.GetClassType();
oParagraph.AddLineBreak();
oParagraph.AddText("Class Type = " + sClassType);
builder.SaveFile("docx", "ApiTextPr.docx");
builder.CloseFile();
Resulting document