Apryse WebViewer

Class: PageNumber

Core.PDFNet. PageNumber

new PageNumber()

A class representing a dynamic page number element.

Extends

Members

<static> NumberFormat

Properties:
Name Type Description
e_lower_roman number
e_upper_roman number
e_lower_letter number
e_upper_letter number
e_ordinal number
e_ordinal_text number
e_chinese_counting number
e_chinese_counting_thousand number
e_cardinal_text number
e_decimal_zero number
e_decimal_double_zero number
e_decimal_triple_zero number
e_decimal_quadruple_zero number
e_arabic_alpha number
e_arabic_abjad number
e_decimal_enclosed_circle_limit_10 number
e_decimal_enclosed_circle_limit_20 number
e_decimal_with_fullstop_limit_20 number
e_decimal_parenthesized_limit_20 number
e_decimal_full_width number
e_taiwanese_counting number
e_taiwanese_digital number
e_taiwanese_counting_thousand number
e_japanese_counting number
e_japanese_legal number
e_japanese_digital_ten_thousand number
e_korean_digital number
e_korean_counting number
e_korean_legal number
e_korean_digital_2 number
e_thai_letters number
e_thai_numbers number
e_thai_counting number
e_vietnamese_counting number
e_russian_lower number
e_russian_upper number
e_hebrew_1 number
e_hebrew_2 number
e_hindi_vowels number
e_hindi_consonants number
e_hindi_numbers number
e_hindi_counting number
e_ideograph_legal_traditional number
e_ideograph_traditional number
e_ideograph_zodiac number
e_ideograph_digital number
e_ideograph_zodiac_traditional number
e_chinese_legal_simplified number

<static> NumberType

Properties:
Name Type Description
e_current_page number
e_total_pages number

Methods

asChart()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.Chart"
Type
Promise.<Core.PDFNet.Chart>

asContentNode()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.ContentNode"
Type
Promise.<Core.PDFNet.ContentNode>

asFloat()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.Float"
Type
Promise.<Core.PDFNet.Float>

asList()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.List"
Type
Promise.<Core.PDFNet.List>

asListItem()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.ListItem"
Type
Promise.<Core.PDFNet.ListItem>

asPageNumber()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.PageNumber"
Type
Promise.<Core.PDFNet.PageNumber>

asParagraph()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.Paragraph"
Type
Promise.<Core.PDFNet.Paragraph>

asShape()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.Shape"
Type
Promise.<Core.PDFNet.Shape>

asTable()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.Table"
Type
Promise.<Core.PDFNet.Table>

asTableCell()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.TableCell"
Type
Promise.<Core.PDFNet.TableCell>

asTableRow()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.TableRow"
Type
Promise.<Core.PDFNet.TableRow>

asTextRun()

Inherited From:
Returns:
A promise that resolves to an object of type: "PDFNet.TextRun"
Type
Promise.<Core.PDFNet.TextRun>

getNumberFormat()

Returns:
A promise that resolves to an object of type: "number" 
PDFNet.PageNumber.NumberFormat = {
	e_lower_roman : 2
	e_upper_roman : 3
	e_lower_letter : 4
	e_upper_letter : 5
	e_ordinal : 6
	e_ordinal_text : 7
	e_chinese_counting : 8
	e_chinese_counting_thousand : 9
	e_cardinal_text : 10
	e_decimal_zero : 11
	e_decimal_double_zero : 12
	e_decimal_triple_zero : 13
	e_decimal_quadruple_zero : 14
	e_arabic_alpha : 15
	e_arabic_abjad : 16
	e_decimal_enclosed_circle_limit_10 : 17
	e_decimal_enclosed_circle_limit_20 : 18
	e_decimal_with_fullstop_limit_20 : 19
	e_decimal_parenthesized_limit_20 : 20
	e_decimal_full_width : 21
	e_taiwanese_counting : 22
	e_taiwanese_digital : 23
	e_taiwanese_counting_thousand : 24
	e_japanese_counting : 25
	e_japanese_legal : 26
	e_japanese_digital_ten_thousand : 27
	e_korean_digital : 28
	e_korean_counting : 29
	e_korean_legal : 30
	e_korean_digital_2 : 31
	e_thai_letters : 32
	e_thai_numbers : 33
	e_thai_counting : 34
	e_vietnamese_counting : 35
	e_russian_lower : 36
	e_russian_upper : 37
	e_hebrew_1 : 38
	e_hebrew_2 : 39
	e_hindi_vowels : 40
	e_hindi_consonants : 41
	e_hindi_numbers : 42
	e_hindi_counting : 43
	e_ideograph_legal_traditional : 44
	e_ideograph_traditional : 45
	e_ideograph_zodiac : 46
	e_ideograph_digital : 47
	e_ideograph_zodiac_traditional : 48
	e_chinese_legal_simplified : 49
}
Type
Promise.<number>

getNumberType()

Returns:
A promise that resolves to an object of type: "number" 
PDFNet.PageNumber.NumberType = {
	e_current_page : 1
	e_total_pages : 2
}
Type
Promise.<number>

getTextStyledElement()

Retrieve the TextStyledElement object for manipulating the text style of this content element.
Inherited From:
Returns:
A promise that resolves to the TextStyledElement object
Type
Promise.<Core.PDFNet.TextStyledElement>

setNumberFormat(format)

Parameters:
Name Type Description
format number 
PDFNet.PageNumber.NumberFormat = {
	e_lower_roman : 2
	e_upper_roman : 3
	e_lower_letter : 4
	e_upper_letter : 5
	e_ordinal : 6
	e_ordinal_text : 7
	e_chinese_counting : 8
	e_chinese_counting_thousand : 9
	e_cardinal_text : 10
	e_decimal_zero : 11
	e_decimal_double_zero : 12
	e_decimal_triple_zero : 13
	e_decimal_quadruple_zero : 14
	e_arabic_alpha : 15
	e_arabic_abjad : 16
	e_decimal_enclosed_circle_limit_10 : 17
	e_decimal_enclosed_circle_limit_20 : 18
	e_decimal_with_fullstop_limit_20 : 19
	e_decimal_parenthesized_limit_20 : 20
	e_decimal_full_width : 21
	e_taiwanese_counting : 22
	e_taiwanese_digital : 23
	e_taiwanese_counting_thousand : 24
	e_japanese_counting : 25
	e_japanese_legal : 26
	e_japanese_digital_ten_thousand : 27
	e_korean_digital : 28
	e_korean_counting : 29
	e_korean_legal : 30
	e_korean_digital_2 : 31
	e_thai_letters : 32
	e_thai_numbers : 33
	e_thai_counting : 34
	e_vietnamese_counting : 35
	e_russian_lower : 36
	e_russian_upper : 37
	e_hebrew_1 : 38
	e_hebrew_2 : 39
	e_hindi_vowels : 40
	e_hindi_consonants : 41
	e_hindi_numbers : 42
	e_hindi_counting : 43
	e_ideograph_legal_traditional : 44
	e_ideograph_traditional : 45
	e_ideograph_zodiac : 46
	e_ideograph_digital : 47
	e_ideograph_zodiac_traditional : 48
	e_chinese_legal_simplified : 49
}
Returns:
Type
Promise.<void>

setNumberType(type)

Parameters:
Name Type Description
type number 
PDFNet.PageNumber.NumberType = {
	e_current_page : 1
	e_total_pages : 2
}
Returns:
Type
Promise.<void>