Class PDFNet.AnnotBorderStyle

PDFNet.AnnotBorderStyle

Class Summary
Constructor Attributes	Constructor Name and Description
	PDFNet.AnnotBorderStyle(id) AnnotBorderStyle structure specifies the characteristics of the annotation's border.

Method Summary
Method Attributes	Method Name and Description
	assign(to) Copy Constructor
	compare(b) Comparison function.
	copy() Copy Constructor
<static>	PDFNet.AnnotBorderStyle.create(s, b_width, b_hr, b_vr) Constructor
<static>	PDFNet.AnnotBorderStyle.createWithDashPattern(s, b_width, b_hr, b_vr, buffer) [Documentation Not Yet Added]
	destroy() Frees the native memory of the object.
	getDashPattern()
	getHR()
	getStyle()
	getVR()
	getWidth()
	setHR(horizontal_radius) Sets horizontal corner radius.
	setStyle(style) Sets the border style.
	setVR(vertical_radius) Sets vertical corner radius.
	setWidth(width) Sets the border width

Class Detail

PDFNet.AnnotBorderStyle(id)

AnnotBorderStyle structure specifies the characteristics of the annotation's border. The border is specified as a rounded rectangle.

Parameters:
id

Method Detail

assign(to)

Copy Constructor

Parameters:
{AnnotBorderStyle} to: (generated documentation)

{[ERROR]} compare(b)

Comparison function. Determines if parameter object is equal to current object.

Parameters:
b

Returns:: {[ERROR]} True if the two objects are equivalent. False otherwise @param {AnnotBorderStyle} b (generated documentation)

{AnnotBorderStyle} copy()

Copy Constructor

Returns:: {AnnotBorderStyle} A promise that resolves to an object of type: "AnnotBorderStyle" (generated documentation)

<static> {AnnotBorderStyle} PDFNet.AnnotBorderStyle.create(s, b_width, b_hr, b_vr)

Constructor

Parameters:

{number/enum} s

(generated enum documentation)

PDFNet.AnnotBorderStyle.Style = {
	e_solid : 0
	e_dashed : 1
	e_beveled : 2
	e_inset : 3
	e_underline : 4
}

{number} b_width

(generated documentation)

{number} b_hr

(generated documentation)

{number} b_vr

(generated documentation)

Returns:: {AnnotBorderStyle} A promise that resolves to an object of type: "AnnotBorderStyle" (generated documentation)

<static> {AnnotBorderStyle} PDFNet.AnnotBorderStyle.createWithDashPattern(s, b_width, b_hr, b_vr, buffer)

[Documentation Not Yet Added]

Parameters:

{number/enum} s

(generated enum documentation)

PDFNet.AnnotBorderStyle.Style = {
	e_solid : 0
	e_dashed : 1
	e_beveled : 2
	e_inset : 3
	e_underline : 4
}

{number} b_width

(generated documentation)

{number} b_hr

(generated documentation)

{number} b_vr

(generated documentation)

{Array} buffer

(generated documentation)

Returns:: {AnnotBorderStyle} A promise that resolves to an object of type: "AnnotBorderStyle" (generated documentation)

destroy()

Frees the native memory of the object.

getDashPattern()

Returns:: the border dash pattern.

See:: BorderStyle()

{number} getHR()

Returns:: {number} A promise that resolves to horizontal corner radius.

{number} getStyle()

Return value enum:
PDFNet.AnnotBorderStyle.Style = {
	e_solid : 0
	e_dashed : 1
	e_beveled : 2
	e_inset : 3
	e_underline : 4
}

Returns:: {number} A promise that resolves to the border style.

{number} getVR()

Returns:: {number} A promise that resolves to vertical corner radius.

{number} getWidth()

Returns:: {number} A promise that resolves to the border width.

setHR(horizontal_radius)

Sets horizontal corner radius.

Parameters:
{number} horizontal_radius: A number representing the value of the horizontal radius to set the annotation to.

setStyle(style)

Sets the border style.

Parameters:

{number/enum} style

(generated enum documentation)

PDFNet.AnnotBorderStyle.Style = {
	e_solid : 0
	e_dashed : 1
	e_beveled : 2
	e_inset : 3
	e_underline : 4
}

setVR(vertical_radius)

Sets vertical corner radius.

Parameters:
{number} vertical_radius: A number representing the value of the vertical radius to set the annotation to.

setWidth(width)

Sets the border width

Parameters:
{number} width: A number representing the width value to set the annotation to.

WebViewer HTML5 API Reference v2.2.1.49322

Classes

Class PDFNet.AnnotBorderStyle