Format Object
Contents
The Format object provides control of typographical formats.
Methods
| DefaultParaStatus Method | Returns the paragraph status object for the selected format. |
| DefaultTextStatus Method | Returns the text status object for the selected format. |
| SelectDlg Method | Displays the format select dialog, and initializes the object properties. |
Properties
Basics
| Id Property | Returns the format id. |
| Name Property | Returns the format name. |
| TitleId Property | Returns the id of the title where the format belongs. |
| Leading Property | Returns the leading of the format. |
Libraries, styles, tags
| NStyleLibs Property | Returns the number of style libraries, assigned to the selected format. |
| ParaStyles Property | Returns an array of tag names of the paragraph styles in all linked libraries of the selected format. |
| TextStyles Property | Returns an array of tag names of the character styles in all linked libraries of the selected format. |
| Macros Property | Returns an array of tag names of the hidden styles in all linked libraries of the selected format. |
Filtering
| CategoryId Property | Returns the id of the category, assigned to the format. |
| TypeId Property | Returns the id of the type, assigned to format |
| MinGeoDepth Property | Returns the min. allowed geometry height, assigned to format. |
| MaxGeoDepth Property | Returns the max. allowed geometry height, assigned to format. |
Fitting
| DefaultParaCopyFit Property | Returns the default paragraph copy fit set, assigned to format. |
Justification
| DisableCaps Property | Returns the status of the Automatic disable small capitals check box of the Global dialog box. |
| LineSpacing Property | Returns the ordinal number of the selected line spacing options. |
| UseLetterSpacing Property | Returns the status of the Use letter spacing check box of the Global dialog box. |
Hyphenation
| BreakableChars Property | Returns the list of hyphenation markers in the format. |
| MaxConsecutiveHyphens Property | Returns the number of allowed consecutive hyphens |
| MinBreakableLen Property | Returns the minimum length of a breakable word in the selected format. |
| NMinAfterHyphen Property | Returns the minimum number of characters after a hyphen in the selected format. |
| NMinBeforeHyphen Property | Returns the minimum number of characters before a hyphen in the selected format. |
To create a Format object:
Dim objFormat = Ted.GetFormat
Dim objFormat = Fred.GetFormat
See also
TxtFormatDlg, TxtFormatName, TxtFormat, TxtFormatList, GetFormat, Format object