OdDropDownList Class

Syntax

C++

class OdDropDownList : public OdObject;

Description

This class implements a drop-down list control contained in a .pdf document created with Publish SDK. A drop-down list contains a list of predefined items that can be selected. Only one of the predefined items can be selected. A user can also enter a custom value to a drop-down list if allowed (see setCustomText() and getCustomText() methods).

Class Hierarchy

File: PdfPublishDropDownList.h

Namespace: OdPdfPublish

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdRxObject	Default constructor for this class. (Inherited from OdRxObject)
~OdDropDownList	Destroys the drop-down list control.
~OdObject	Destroys an instance of a Publish SDK object. (Inherited from OdObject)
~OdRxObject	The virtual destructor for this class. (Inherited from OdRxObject)

Methods

Show:Inherited

No members matching the current filter

addRef	Declares the method incrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
cast	Casts the specified raw pointer to the smart pointer. (Inherited from OdRxObject)
clear	Clears the Publish SDK object. (Inherited from OdObject)
clone	Creates a clone of this object, and returns a pointer to the clone. (Inherited from OdRxObject)
comparedTo	Compares another object to this one in a some meaning. (Inherited from OdRxObject)
copyFrom	details Copies the contents of the specified object into this object. (Inherited from OdRxObject)
desc	Returns the raw pointer to the class describing instance statically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
getBorder	Returns the current value of the flag that determines whether the drop-down list has a border. If the flag value is equal to true, the drop-down list has a border, otherwise it does not. The method fills a passed boolean value with the drop-down list border flag value and returns it to a calling subroutine.
getBorderColor	Returns the current drop-down list border color. The method fills a passed ODCOLORREF value with the drop-down list border color value and returns it to a calling subroutine.
getBorderStyle	Returns the current drop-down list border style. The method fills a passed value with the current border style value and returns it to a calling subroutine.
getBorderThickness	Returns the current drop-down list border thickness. The method fills a passed value with the current border thickness and returns it to a calling subroutine.
getContents	Returns the current drop-down list content. The method fills the passed string arrays with display and export items respectively and returns them to a calling subroutine.
getCustomText	Returns the current value of the custom text flag of the drop-down list. The custom text flag determines whether a user can add a custom value to the drop-down list. If the flag is equal to true, a user can enter a custom value, otherwise the user can only select one of the predefined values from the drop-down list. The method fills a passed boolean value with the custom text flag value and returns it to a calling subroutine.
getFillColor	Returns the current drop-down list fill color. The method fills a passed ODCOLORREF value with the drop-down list fill color value and returns it to a calling subroutine.
getFont	Returns the current font name used for displaying drop-down list items. The method fills a passed string object and Text::FontStyle value with the drop-down list font name and font style, then returns them to a calling subroutine.
getFontSize	Returns the current font size used for displaying drop-down list items. The method fills a passed integer value with the drop-down list font size and returns it to a calling subroutine.
getImmediateCommit	Returns the current value of the immediate commit flag of the drop-down list. The immediate commit flag determines whether user text entered in the drop-down list is committed immediately (if set to true). The method fills a passed boolean value with the immediate commit flag value and returns it to a calling subroutine.
getLock	Returns the current value of the flag that determines whether the drop-down list is locked. If the flag value is equal to true, the drop-down list is locked and becomes disabled, otherwise it is enabled and unlocked. The method fills a passed boolean value with the drop-down list lock flag value and returns it to a calling subroutine.
getName	Returns the current name of the drop-down list. The method fills a passed string object with the drop-down list name and returns it to a calling subroutine.
getPrintability	Returns the current value of the flag that determines whether the drop-down list should be printed. If the drop-down list should be printed, the flag value is equal to true, otherwise it is equal to false. The method fills a passed boolean value with the drop-down list printability flag value and returns it to a calling subroutine.
getSpellChecking	Returns the current value of the spell-checking flag of the drop-down list. The spell-checking flag determines whether user text entered in the drop-down list should be checked. If the flag is equal to true, the custom value of the drop-down list is spell-checked, otherwise the drop-down list does not spell-check the user text. The method fills a passed boolean value with the spell-checking flag value and returns it to a calling subroutine.
getTextColor	Returns the current text color used for displaying drop-down list items. The method fills a passed ODCOLORREF value with the drop-down list caption color and returns it to a calling subroutine.
getTextRotation	Returns the current rotation of the drop-down list text. The method fills a passed value with the current text rotation value and returns it to a calling subroutine.
getTooltip	Returns the current tooltip text for the drop-down list. Tooltip text is text that appears when a user hovers the mouse pointer over the drop-down list. The method fills a passed string object with the drop-down list tooltip text and returns it to a calling subroutine.
getVisibility	Returns the current value of the visibility flag for the drop-down list. The visibility flag determines whether the drop-down list is visible in a document (if true) or is hidden (if false). The method fills a passed boolean value with the drop-down list visibility flag value and returns it to a calling subroutine.
isA	Returns the raw pointer to the class describing instance dynamically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
isEmpty	Determines whether the Publish SDK object is empty. (Inherited from OdObject)
isEqualTo	Returns true if and only if the specified object is equal to this one in a some meaning. (Inherited from OdRxObject)
isKindOf	Checks whether the object belongs to the specified class and returns true if and only if this object is an instance of the specified class or a subclass of the specified class. (Inherited from OdRxObject)
isValid	Determines whether the Publish SDK object is valid. (Inherited from OdObject)
numRefs	Returns the value of the reference counter, that is, the number of references to an instance of this class. (Inherited from OdRxObject)
queryX	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class. (Inherited from OdRxObject)
release	Declares the method decrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
rxInit	for internal use (Inherited from OdRxObject)
rxUninit	(Inherited from OdRxObject)
setBorder	Sets a new value of the flag that determines whether the drop-down list has a border. If the flag value is equal to true, the drop-down list has a border, otherwise it does not.
setBorderColor	Sets a drop-down list border color.
setBorderStyle	Sets a new border style for the drop-down list.
setBorderThickness	Sets a new value for the drop-down list border thickness.
setContents	Sets the drop-down list content. The method fills the drop-down list with an array of items. Each item is a string value.
setCustomText	Sets a new value of the custom text flag for the drop-down list. The custom text flag determines whether a user can add a custom value to the drop-down list. If the flag is equal to true, a user can enter a custom value, otherwise the user can only select one of the predefined values from the drop-down list.
setFillColor	Sets a drop-down list fill color.
setFont(const OdString&, Text::FontStyle, Text::Language, bool)	This is the overview for the setFont method overload.
setFontSize	Sets a font size for the drop-down list.
setImmediateCommit	Sets a new value of the immediate commit flag for the drop-down list. The immediate commit flag determines whether user text entered in the drop-down list is committed immediately (if set to true).
setLock	Sets a new value of the flag that determines whether the drop-down list is locked. If the flag value is equal to true, the drop-down list is locked and becomes disabled, otherwise it is enabled and unlocked.
setName	Sets the drop-down list name.
setPrintability	Sets a new value of the flag that determines whether the drop-down list should be printed. If the drop-down list should be printed, the flag value is equal to true, otherwise it is equal to false.
setSpellChecking	Sets a new value of the spell-checking flag for the drop-down list. The spell-checking flag determines whether user text entered in the drop-down list should be checked. If the flag is equal to true, the custom value in the drop-down list is spell-checked, otherwise the drop-down list does not spell-check the user text.
setTextColor	Sets a text color for the drop-down list.
setTextRotation	Sets a new value for the drop-down list text rotation.
setTooltip	Sets tooltip text for the drop-down list. Tooltip text is text that appears when a user hovers the mouse pointer over the drop-down list.
setVisibility	Sets a new value of the visibility flag for the drop-down list. The visibility flag determines whether the drop-down list is visible in a document (if true) or is hidden (if false).
x	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class, or throws an exception if it cannot. (Inherited from OdRxObject)

Links

OdDropDownList Methods

Relief for ODA Team in Ukraine