PdfMarkupAnnot class.
More...
PdfMarkupAnnot class.
Markup annotations represent a markup annotation in a pdf document.
◆ AddReply()
| virtual PdfAnnot* PdfMarkupAnnot::AddReply |
( |
const wchar_t * |
author, |
|
|
const wchar_t * |
text |
|
) |
| |
|
pure virtual |
Adds a new reply to the markup annotation.
- Parameters
-
| author | The author of the reply. |
| text | The content of the reply to add. |
- Returns
- Requested PdfAnnot that is reply to the current annotation or nullptr in case of error.
- See also
- PdfMarkupAnnot::AddReply Sample AddComment
◆ GetAuthor()
| virtual int PdfMarkupAnnot::GetAuthor |
( |
wchar_t * |
buffer, |
|
|
int |
len |
|
) |
| |
|
pure virtual |
Gets the author of the markup annotation.
- Parameters
-
| buffer | (filled by method) If the buffer is null function returns required length of string |
| len | Length of a buffer to be filled in. |
- Returns
- Number of characters written into buffer of required length.
- See also
- PdfMarkupAnnot::GetAuthor
◆ GetContents()
| virtual int PdfMarkupAnnot::GetContents |
( |
wchar_t * |
buffer, |
|
|
int |
len |
|
) |
| |
|
pure virtual |
Gets the contents of the markup annotation. It's a 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.
- Parameters
-
| buffer | (filled by method) If the buffer is null function returns required length of string |
| len | Length of a buffer to be filled in. |
- Returns
- Number of characters written into buffer of required length.
- See also
- PdfMarkupAnnot::GetContents
◆ GetNumReplies()
| virtual int PdfMarkupAnnot::GetNumReplies |
( |
| ) |
|
|
pure virtual |
Both annotations must be on the same page of the document.
Gets the requested reply. Reply is a reference to another PdfAnnot object that was created
- Returns
- Number of replies.
- See also
- PdfMarkupAnnot::GetNumReplies
◆ GetReply()
| virtual PdfAnnot* PdfMarkupAnnot::GetReply |
( |
int |
index | ) |
|
|
pure virtual |
Both annotations must be on the same page of the document.
Gets the requested reply. Reply is a reference to another PdfAnnot object that was created
- Returns
- Requested PdfAnnot that is reply to the current annotation.
- See also
- PdfMarkupAnnot::GetReply
◆ SetAuthor()
| virtual bool PdfMarkupAnnot::SetAuthor |
( |
const wchar_t * |
author | ) |
|
|
pure virtual |
Sets the author of the markup annotation.
- Parameters
-
| author | The content string to be set. |
- Returns
- true if the author was set, false otherwise.
- See also
- PdfMarkupAnnot::SetAuthor
◆ SetContents()
| virtual bool PdfMarkupAnnot::SetContents |
( |
const wchar_t * |
contents | ) |
|
|
pure virtual |
Sets the contents of the markup annotation. It's a 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.
- Parameters
-
| contens | The content string to be set. |
- Returns
- true if the content was set, false otherwise.
- See also
- PdfMarkupAnnot::SetContents
Public Member Functions inherited from PdfAnnot
1.8.17