API Reference > Namespaces > OdPdfPublish Namespace > Classes > OdAnnotation Class > OdAnnotation Methods > OdAnnotation::getCarouselButtons Method
OdAnnotation::getCarouselButtons Method
Syntax
C++
void getCarouselButtons(OdStringArray& button_names, OdString& previous_button_name, OdString& next_button_name, OdUInt16& scroll_size) const;
Parameters 
Description 
OdStringArray& button_names 
[out] A placeholder for the array of button names.  
OdString& previous_button_name 
[out] A placeholder for the name of the previous button.  
OdString& next_button_name 
[out] A placeholder for the name of the next button.  
OdUInt16& scroll_size 
[out] A placeholder for the scroll size value. 

Returns the annotation carousel buttons information. The information contains button names, including previous and next button names, and scroll size value. The method fills the passed objects with button information and returns them to a calling subroutine. 

 

A carousel buttons array includes a collection of buttons to switch between different views (each button contains a small preview) and two specific buttons for switching to a previous or next view relative to the view that is currently displayed. The scroll size property determines how many buttons are scrolled when the user presses the next or previous button. 

It is necessary to set carousel buttons to generate a carousel view.

Copyright © 2002–2020. Open Design Alliance. All rights reserved.