OdAnnotation Class

Syntax

C++

class OdAnnotation : public OdObject;

Description

This class implements an annotation entity for .pdf documents created with Publish SDK. An annotation is a user space object that stores a set of objects of different types (acts like a container for other objects and controls). Annotations can contain compressed and uncompressed .prc tessellations, .prc boundary representation data, .prc attributes, and carousel buttons which allow users to interactively switch between different views. An annotation entity is based on a CAD model. The CAD model represents any drawing in a format supported by ODA Software (for example, a .dwg drawing), exported to PRC data format.

Class Hierarchy

File: PdfPublishAnnotation.h

Namespace: OdPdfPublish

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdRxObject	Default constructor for this class. (Inherited from OdRxObject)
~OdAnnotation	Destroys an annotation object.
~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)
getActivation	Returns the annotation activation type. The method fills a passed activation type value and returns it to a calling subroutine.
getArtwork	Returns a smart pointer to the annotation artwork object. The method fills a passed smart pointer value and returns it to a calling subroutine.
getBorderWidth	Returns the current border width of the annotation. The method fills a passed value and returns it to a calling subroutine.
getCarouselButtons	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.
getCarouselButtonsAlignment	Retrieves the current alignment for carousel buttons. The method fills the passed value of the Alignment enumeration with the current alignment and returns it to a calling subroutine.
getCarouselButtonsFillColor	Returns a color that is used for filling the carousel buttons.
getCarouselButtonsFont	Returns the current font parameters of carousel buttons. The method fills passed values and returns them to a calling subroutine.
getCarouselButtonsFontSize	Returns the carousel buttons font size. The method fills a passed value and returns it to a calling subroutine.
getCarouselButtonsOffset	Returns a offset between annotations and the carousel buttons.
getCarouselScrollButtonsImages	Returns the images for carousel scroll buttons.
getCarouselViews	Returns the carousel views of the annotation. The view information contains an array of view indices and an array of button icons. The method fills the passed objects with data about the views and returns them to a calling subroutine.
getDeactivation	Returns the annotation deactivation type. The method fills a passed deactivation type value and returns it to a calling subroutine.
getInteractivity	Returns the current value of the interactivity flag of the annotation. The method fills a passed boolean value and returns it to a calling subroutine.
getModelTreeVisibility	Returns the current value of the visibility flag of the annotation model tree. The method fills a passed boolean value and returns it to a calling subroutine.
getName	Returns the annotation name. The method fills a passed string object and returns it to a calling subroutine.
getPartsList	Returns the table that contains the list of annotation parts. The method accepts placeholders for the parts list table, fills them and returns to a calling subroutine.
getPosterImage	Returns the annotation poster image. The method fills a passed smart pointer to an image object and returns it to a calling subroutine.
getPropertyList	Returns the current location of the property list label.
getPropertyToTextField	Returns the current text field property with a specified name.
getSource	Returns the annotation source. The method fills a passed smart pointer to the model object and returns it to a calling subroutine.
getToolbarVisibility	Returns the current value of the visibility flag of the annotation toolbar. The method fills a passed boolean value and returns it to a calling subroutine.
getTransparentBackground	Returns the current value of the transparency flag of the annotation. The method fills a passed boolean value and returns it to a calling subroutine.
getViewList	Returns the list box object that contains the list of view names. The method fills the passed location and list box objects, then returns them to a calling subroutine.
getViewListField	Returns a list of view names combined in a single string. The method fills the passed string objects with view names 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)
setActivation	Sets the annotation activation type. The activation type determines when the annotation becomes active.
setArtwork	Sets an artwork object of the annotation.
setBorderWidth	Sets the border width of the annotation. Border width is measured in points.
setCarouselButtons	Sets the annotation carousel buttons.
setCarouselButtonsAlignment	Sets the alignment for carousel buttons.
setCarouselButtonsFillColor	Sets a color that is used for filling the carousel buttons.
setCarouselButtonsFont(const OdString&, Text::FontStyle, Text::Language, bool)	This is the overview for the setCarouselButtonsFont method overload.
setCarouselButtonsFontSize	Sets the carousel buttons font size.
setCarouselButtonsOffset	Sets a offset between annotations and the carousel buttons.
setCarouselScrollButtonsImages	Sets the images for carousel scroll buttons.
setCarouselViews	Sets the carousel views of the annotation.
setDeactivation	Sets the annotation deactivation type. The deactivation type determines when the annotation becomes inactive.
setInteractivity	Sets the interactivity flag of the annotation. If the flag is true, annotation interactivity is enabled, otherwise interactivity is disabled.
setModelTreeVisibility	Sets the visibility flag of the annotation model tree. If the flag is true, the model tree is diplayed when the annotation becomes active, otherwise the model tree stays hidden.
setName	Sets the annotation name.
setPartsList	Sets the table that contains the list of annotation parts.
setPosterImage	Sets the annotation poster image.
setPropertyList	Creates a new OdList object in a specified location and fills it with property values of the node selected at the annotation object. If the node has no property, the list object remains empty.
setPropertyToTextField	Displays the property value of the selected node to a specified text field. The property to be displayed is defined by its name.
setSource	Sets the annotation source. The source contains drawing data that should be exported to the annotation.
setToolbarVisibility	Sets the visibility flag of the annotation toolbar. If the flag is true, the toolbar is diplayed when the annotation becomes active, otherwise the toolbar stays hidden.
setTransparentBackground	Sets the transparency flag of the annotation. If the flag is true, the annotation background is transparent, otherwise the annotation background is opaque.
setViewList	Adds a new list box object in a specified area and creates a list of view names in it.
setViewListByField	Creates a new list of view names combined in a single string.
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

OdAnnotation Methods

Relief for ODA Team in Ukraine