HI_GetSplitterRelPos

HI_GetSplitterRelPos

%HI_GetSplitterRelPos, %HI_SetSplitterRelPos functions


Function

The function %HI_SetSplitterRelPos sets the position of the splitter object's slider according to the given relative position (Control function).

The %HI_GetSplitterRelPos function finds the relative position of the splitter object's slider.

Declaration

%HI_SetSplitterRelPos( INT in refId, REAL in value ) REAL %HI_GetSplitterRelPos( INT in refId )

Parameters

refId

Reference to the splitter object (reference variable).

value

Relative position of the slider - a number from the interval <0,1>.

Note

If the value of the %HI_SetSplitterRelPos function is outside the required interval, the requested operation will not be performed. 

The %HI_SetSplitterRelPos function has no return value.

The %HI_GetSplitterRelPos function returns an invalid value if the dimension (depending on the direction of movement) of the splitter object is 0.