TerGetParaInfo
Get paragraph attributes.
bool TerGetParaInfo( LineNo, out LeftIndent, out RightIndent, out FirstIndent, out TabId, out StyleId, out AuxId, out Shading, out pflags, out SpaceBefore, out SpaceAfter, out SpaceBetween, out flags);
bool TerGetParaInfo2( LineNo, out LeftIndent, out RightIndent, out FirstIndent, out TabId, out StyleId, out AuxId, out Shading, out pflags, out SpaceBefore, out SpaceAfter, out SpaceBetween, out flags, out Aux1Id, out BkColor);
bool TerGetParaInfo3( LineNo, IsStyleItem, out LeftIndent, out RightIndent, out FirstIndent, out TabId, out StyleId, out AuxId, out Shading, out pflags, out SpaceBefore, out SpaceAfter, out SpaceBetween, out flags, out Aux1Id, out BkColor);
bool TerGetParaInfo4( LineNo, IsStyleItem, out LeftIndent, out RightIndent, out FirstIndent, out TabId, out StyleId, out AuxId, out Shading, out pflags, out SpaceBefore, out SpaceAfter, out SpaceBetween, out flags, out Aux1Id, out BkColor, out LineSpacing);
int LineNo; | Line number to retrieve the paragraph information. To specify a para id instead of a line number, specify a negative value. |
bool IsStyleItem; | This parameter is applicable to the TerGetParaInfo3 function only. It allows you to retrieve the paragraph information for a style item. When this flag is set to true, the LineNo parameter should be used to pass a style id to retrieve its information. You can also set the LineNo to SID_CUR to get the paragraph information about the style being currently edited. |
int LeftIndent; | Left indentation (in twips). |
int RigthIndent; | Right indentation (in twips). |
int FirstIndent; | Indentation for the first line (in twips). |
int TabId; | Tab id. |
int StyleId; | Paragraph Style id. |
int AuxId; | An application specified id. |
int shading; | Shading amount: a value from 0 (no shading) to 10000 (darkest shading). |
int pflags; | Additional paragraph flags: |
| PFLAG_WIDOW: | Widow/orphan control |
| PFLAG_PAGE_BREAK: | Page break before the paragraph |
int SpaceBefore; | Space before the paragraph (in twips). |
int SpaceAfter; | Space after the paragraph (in twips). |
int SpaceBetween; | Space between the paragraph lines (in twips). |
int flags; | Paragraph attribute flags. Please refer to the 'SetTerParaFmt' function for a list of paragraph attribute ids. |
int Aux1Id; | Another application specified id. |
Color BkColor; | Paragraph background color. |
int LineSpacing; | Extra line spacing in percentage |
Return Value: This function returns a true value when successful. Otherwise it returns false.