Class to represent pop-up annotation. More...
Inherits Foxit::PDF::Annotations::IAnnot.
Public Member Functions | |
virtual Boolean | IsMarkup () |
Check if current annotation is a markup annotation. More... | |
virtual AnnotType | GetType () |
Get the type of current annotation. More... | |
virtual String^ | GetContents () |
Get the contents data. More... | |
virtual void | SetContents (String^ content) |
Set the contents data. More... | |
virtual DateTime^ | GetModifiedTime () |
Get the last modification time. More... | |
virtual void | SetModifiedTime (DateTime^ modifiedTime) |
Set the last modification time. More... | |
virtual uint32 | GetFlags () |
Get annotation flags. More... | |
virtual void | SetFlags (uint32 flags) |
Set annotation flags. More... | |
virtual String^ | GetName () |
Get annotation name string. More... | |
virtual void | SetName (String^ name) |
Get annotation name string. More... | |
virtual RectF^ | GetRect () |
Get rectangle value. More... | |
virtual Boolean | Move (RectF^ rect) |
Move current annotation to a new position specified by a rectangle. More... | |
virtual BorderInfo^ | GetBorderInfo () |
Get border information. More... | |
virtual void | SetBorderInfo (BorderInfo^ border) |
Set border information. More... | |
Boolean | GetOpenStatus () |
Get the open status. More... | |
void | SetOpenStatus (Boolean status) |
Set the open status. More... | |
Additional Inherited Members | |
![]() | |
int64 | pointer |
Pointer to a handle of PDF annotation object. This pointer is not useful outside this SDK. The application should not access the pointer to the handle of the PDF annotation object directly. | |
Class to represent pop-up annotation.
A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing. It typically does not appear alone but is associated with a markup annotation, its parent annotation, and is used for editing the parent’s text. It has no appearance stream or associated actions of its own.
|
virtual |
Get border information.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get the contents data.
Contents data is the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get annotation flags.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get the last modification time.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get annotation name string.
The annotation name, a text string uniquely identifying it among all the annotations on its page.
Implements Foxit::PDF::Annotations::IAnnot.
Boolean Foxit::PDF::Annotations::Popup::GetOpenStatus | ( | ) |
Get the open status.
Open status indicates whether current pop-up annotation should initially be displayed open or closed.
|
virtual |
Get rectangle value.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get the type of current annotation.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Check if current annotation is a markup annotation.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Move current annotation to a new position specified by a rectangle.
To move an annotation is to reset its rectangle.
[in] | rect | A Foxit::RectF object that specifies the new position. The rect should be "normalized" for PDF page coordination: left is always smaller than right, and bottom is always smaller than top. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Set border information.
[in] | border | An Annotations::BorderInfo object that specifies the new border information to be set. Please refer to comment of Annotations::BorderInfo for more details. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Set the contents data.
Contents data is the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.
Please ensure that a free text annotation has already been set the default appearance property for keeping its contents data useful.
[in] | content | A String object that specifies the new contents data to be set. It can be nullptr or empty. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Set annotation flags.
[in] | flags | Value of flags. Please refer to enumeration Annotations::Flags and this can be one or combination of its values. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Set the last modification time.
[in] | modifiedTime | A Foxit::DateTime object that specifies the new last modification time data to be set. It should be valid and should not be nullptr. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get annotation name string.
The annotation name, a text string uniquely identifying it among all the annotations on its page.
[in] | name | A String object that specifies the new name string. This can be nullptr or empty. |
Implements Foxit::PDF::Annotations::IAnnot.
void Foxit::PDF::Annotations::Popup::SetOpenStatus | ( | Boolean | status | ) |
Set the open status.
Open status indicates whether current pop-up annotation should initially be displayed open or closed.
[in] | status | A boolean value that specifies the new open status: true means open status is "open", while false means open status is "closed". |