Skip to main content
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. Later, the object can be re-created by reading the object’s state from the persistent storage. The following methods provide persistence of the object: Linux: SaveToFile, and LoadFromFile Windows SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.

​
Properties

NameTypeDescription
GapintSpecifies 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.
GapMeasurementUnitGapMeasurementUnitEnumSpecifies the measurement unit of the gap between the blocks. This property is GMU\_PercentOfMinimumFontSize by default.

​
Methods

NameDescription
CopyFromInitializes properties of the current object with values of similar properties of another object.
LoadFromFileRestores the object contents from a file on disk.
LoadFromMemory <Note> : Windows only. </Note>Restores the object contents from the global memory.
SaveToFileSaves the object contents into a file on disk.
SaveToMemory <Note> : Windows only. </Note>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

Layout
Working with Properties