SortingBlocksParams Object (ISortingBlocksParams Interface)
This object is used for setting up the parameters of combining the blocks of data into groups.
The SortingBlocksParams 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 |
---|---|---|
Gap | int |
Specifies the size of the gap between blocks. The blocks will be grouped together if the gap between them is not larger than the value of this property. This property is 0 by default. |
GapMeasurementUnit | GapMeasurementUnitEnum |
Specifies the measurement unit of the gap between the blocks. This property is GMU_PercentOfMinimumFontSize by default. |
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. |
Input parameter
This object is passed as an input parameter to the SortedBlocks property of the Layout object.
Output parameter
This object is the output parameter of the CreateSortingBlocksParams method of the Engine object.
See also
9/17/2024 3:14:41 PM