ParagraphParams Object (IParagraphParams Interface)
This object exposes extended properties of a single paragraph.
Important! If you wish to work with the properties of a single paragraph, you must first call any of the functions that perform synthesis (e.g., the Process or Synthesize method of the FRDocument object), as these properties become meaningful only after synthesis.
The ParagraphParams object is a persistent object. This means that the object's current state can be written to persistent storage: an area in the global memory or a disk file. Later, the object can be re-created by reading the object's state from persistent storage. The following methods provide persistence of the object: SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.
Properties
| Name | Type | Description |
|---|---|---|
| Application | Engine, read-only | Returns the Engine object. |
| Common attributes | ||
| IsRightToLeft | VARIANT_BOOL |
Indicates if the paragraph has right-to-left writing direction (like for Hebrew). By default, the value of this property is FALSE. |
| BackgroundColor | int |
Stores the background color of the text.
By default, the value of this property is -1, which means that the color is transparent. |
| Indents and spacing | ||
| ParagraphAlignment | ParagraphAlignmentEnum |
Stores and allows you to change the horizontal paragraph alignment. By default, this value is PA_Left. |
| FirstLineIndent | int |
Contains and allows you to set the indent of the first line of the paragraph from the left border of the paragraph. The value of this property is measured in 1/100 of a typographical point and affects the results of the export. By default, this value is 0. |
| LeftIndent | int |
Contains and allows you to set the left indent for the paragraph. The value of indent is the distance from the left border of the block to the left border of the paragraph. The value of this property is measured in 1/100 of a typographical point and affects the results of the export. By default, this value is 0. |
| RightIndent | int |
Contains and allows you to set the right indent for the paragraph. The value of indent is the distance from the right border of the block to the right border of the paragraph. The value of this property is measured in 1/100 of a typographical point and affects the results of the export. By default, this value is 0. |
| LineSpacing | int |
Contains and allows you to set the line spacing for the paragraph (in 1/100 of a typographical point). The value of line spacing is the average distance between base lines of paragraph strings. The zero value of this property means that the line spacing is undefined or does not have a sense (for example, for a text in barcode block). If the value of this property is zero, it is ignored during recognized text export. By default, this value is 0. |
| SpaceAfter | int |
Contains and allows you to set the value of space after the paragraph. The space after the paragraph is the distance from the bottom border of block or top border of the next paragraph to the bottom border of the paragraph itself. The value of this property is measured in 1/100 of a typographical point and affects the results of the export. By default, this value is 0. |
| SpaceBefore | int |
Contains and allows you to set the value of space before the paragraph. The space before the paragraph is the distance from the top border of block or bottom border of previous paragraph to the top border of the paragraph itself. The value of this property is measured in 1/100 of a typographical point and affects the results of the export. By default, this value is 0. |
Methods
| Name | Description |
|---|---|
| CopyFrom | Initializes properties of the current object with values of similar properties of another object. |
| LoadFromFile | Restores the object contents from a file on disk. |
| LoadFromMemory | Restores the object contents from the global memory. |
| SaveToFile | Saves the object contents into a file on disk. |
| SaveToMemory | Saves the object contents into the global memory. |
Related objects
Output parameter
This object is the output parameter of the CreateParagraphParams method of the Engine object.
See also
9/17/2024 3:14:41 PM