ImageGear for C and C++ on Windows v19.6 - Updated
IG_dspl_scroll_set
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Display Functions > IG_dspl_scroll_set

This function sets the scroll parameters (not scroll position) and allows you to enable and disable the vertical and horizontal scrollbars associated with a given window.

Declaration:

 
Copy Code
AT_ERRCOUNT  ACCUAPI  IG_dspl_scroll_set( 
        [IN] HIGEAR hIGear, 
        [IN] DWORD dwGrpID,
        [IN] HWND hWnd,
        [IN] AT_MODE nScrollMode,
        [IN] INT nXPage,
        [IN] INT nYPage,
        [OUT] LPAT_SCROLL_INFO lpScrollInfo
);

Arguments:

Name Type Description
hIGear HIGEAR ImageGear handle of image.
dwGrpID DWORD Identifier of group in which to set scroll options.
hWnd HWND Handle of window where image is drawn.
nScrollMode AT_MODE New value of ScrollbarMode to set. Possible value is a combination of the horizontal scrollbar flag:
  • IG_DSPL_HSCROLLBAR_AUTO
  • IG_DSPL_HSCROLLBAR_ENABLE
  • IG_DSPL_HSCROLLBAR_DISABLE
and the vertical:
  • IG_DSPL_VSCROLLBAR_AUTO
  • IG_DSPL_VSCROLLBAR_ENABLE
  • IG_DSPL_VSCROLLBAR_DISABLE
nXPage INT New value of scrolling page width. If 0 then it will be calculated from ClipRect.
nYPage INT New value of scrolling page height. If 0 then it will be calculated from ClipRect.
lpScrollInfo LPAT_SCROLL_INFO Where to copy new scroll parameters. If NULL then the parameter is ignored.

Return Value:

Returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Example:

 
Copy Code
HIGEAR           hIGear;      /* HIGEAR handle of image  */ 
DWORD           nGrpID;        /* display group identifier   */
AT_SCROLL_INFO  ScrollInfo;      /* scroll info  */
 ...
/* always hide both scrollbars */
IG_dspl_scroll_set( hIGear, nGrpID, hWnd,
IG_DSPL_HSCROLLBAR_DISABLE|IG_DSPL_VSCROLLBAR_DISABLE, 0, 0,  &ScrollInfo );
 ...