OdStickyNote Class

Syntax

C++

class OdStickyNote : public OdObject;

Description

This class implements functionality for work with a sticky note in a PDF document created with Publish SDK. A sticky note allows specification of an icon on the page that, when is clicked, displays a popup window with text information.

Class Hierarchy

File: PdfPublishStickyNote.h

Namespace: OdPdfPublish

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdRxObject	Default constructor for this class. (Inherited from OdRxObject)
~OdObject	Destroys an instance of a Publish SDK object. (Inherited from OdObject)
~OdRxObject	The virtual destructor for this class. (Inherited from OdRxObject)
~OdStickyNote	Destroys the sticky note object.

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)
getColor	Returns the current color of the sticky note object. The method fills a passed ODCOLORREF value with the sticky note object's color and returns it to a calling subroutine.
getContents	Returns the content displayed in the popup window for the sticky note object. The method fills a passed string object with the popup window content and returns it to a calling subroutine.
getCreationDate	Returns the creation date and time of the sticky note object. The method fills a passed OdTimeStamp object with the sticky note object's creation date and time and returns it to a calling subroutine.
getDescription	Returns the description of the sticky note object. The method fills a passed string object with the sticky note description and returns it to a calling subroutine.
getLock	Returns the current value of the lock flag for the sticky note. The lock flag determines whether a user can not edit the content of the sticky note object (equals true); otherwise, a user can edit the sticky note object content (equals false).
getMarkedState	Returns the current value of the marked state for the sticky object. The method fills the passed value of the StickyNoteMarkedStates enumeration with the current value of the marked state and returns it to a calling subroutine.
getOpacity	Returns the icon opacity for the sticky note object. The method fills a passed unsigned 8-bit integer value with the opacity value and returns it to a calling subroutine.
getOpen	Returns the current value of the popup window flag for the sticky note object. The popup window flag determines whether a reader application displays the sticky note object when opens the PDF document (equals true). Otherwise, the reader application doesn't display the sticky note (equals false).
getPopupLocation	Returns the location of the popup window that displays the sticky note object's content. The method fills the content of the passed OdRect instance with location data and returns it to a calling subroutine.
getReviewState	Retrieves the review status for the sticky note object. The method fills a passed value of the StickyNoteReviewStates enumeration with the current value of the review status and returns it to a calling subroutine.
getStickyNoteType	Returns the type of the sticky note object. The method fills a passed instance of the StickyNoteTypes enumeration value with the current type of the sticky note object and returns it to a calling subroutine.
getTitle	Returns the title of the popup window for the sticky note object. The method fills a passed string object with the popup window's title 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)
setColor	Sets the color of the sticky note object.
setContents	Sets the content displayed in the popup window for the sticky note object.
setCreationDate	Sets the creation date and time of the sticky note object.
setDescription	Sets the description of the sticky note object.
setLock	Sets a new value of the lock flag for the sticky note. The lock flag determines whether a user can not edit the content of the sticky note object (equals true); otherwise, a user can edit the sticky note object content (equals false).
setMarkedState	Sets a new value of the marked state for the sticky object.
setOpacity	Sets the icon opacity for the sticky note object.
setOpen	Sets a new value of the popup window flag for the sticky note object. The popup window flag determines whether a reader application displays the sticky note object when opens the PDF document (equals true). Otherwise, the reader application doesn't display the sticky note (equals false). Default value of the flag equals false.
setPopupLocation	Sets the location of the popup window where the sticky note object appears.
setReviewState	Sets the review status for the sticky note object.
setStickyNoteType	Sets the type of the sticky note object.
setTitle	Sets the title of the popup window for the sticky note object.
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

OdStickyNote Methods

Relief for ODA Team in Ukraine