Accusoft.PdfXpress5.Net
GetAnnotationName Method
See Also Send Feedback

Accusoft.PdfXpressSdk Namespace > Document Class : GetAnnotationName Method

whichPage: An integer value which represents the zero-based page index.
Valid values: [ 0 , Document.PageCount )

whichAnnotation: An integer value which represents the zero-based PDF Annotation index.
Valid values: [ 0 , Document.GetAnnotationCount( whichPage ) )

Reports the name of a PDF Annotation.

Syntax

Visual Basic

Managed Extensions for C++

C++/CLI

'Declaration
 
Public Function GetAnnotationName( _
   ByVal whichPage As Integer, _
   ByVal whichAnnotation As Integer _
) As String

'Usage
 
Dim instance As Document
Dim whichPage As Integer
Dim whichAnnotation As Integer
Dim value As String
 
value = instance.GetAnnotationName(whichPage, whichAnnotation)

public string GetAnnotationName( 
   int whichPage,
   int whichAnnotation
)

public: string* GetAnnotationName( 
   int whichPage,
   int whichAnnotation
)

public:
String^ GetAnnotationName( 
   int whichPage,
   int whichAnnotation
)

Parameters

whichPage: An integer value which represents the zero-based page index.
Valid values: [ 0 , Document.PageCount )
whichAnnotation: An integer value which represents the zero-based PDF Annotation index.
Valid values: [ 0 , Document.GetAnnotationCount( whichPage ) )

Return Value

The name of whichAnnotation on whichPage in the PDF document.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	Thrown if the parameter whichPage is not a valid value.
System.ArgumentOutOfRangeException	Thrown if the parameter whichAnnotation is not a valid value.
PdfXpressException	Thrown if the parameter whichPage does not possess PDF Annotations.
PdfXpressException	Thrown if the parameter whichAnnotation does not possess a name.
PdfXpressNotIntializedException	Thrown if invoked before PDF Xpress is initialized.
PdfXpressLicensingException	Thrown if this feature is unavailable for the current license edition.

Remarks

Valid values: [ 0 , Document.PageCount )

Valid values: [ 0 , Document.GetAnnotationCount( whichPage ) )

Syntax

Parameters

Return Value

Exceptions

Remarks

See Also

Reference