Foxit::PDF::Annotations::BorderInfo Class Reference

Class to represent annotation border information. More...

Public Member Functions

 BorderInfo (uint32 color, float32 width, BorderStyle style, float32 intensity, float32 dashPhase, const Array< float32 >^dashPatterns)
 Constructor to initialize a new instance of class Annotations::BorderInfo with specific values.
 

Properties

uint32 Color
 Border color. Format: 0xAARRGGBB, and alpha value is ignored.
 
float32 Width
 Width of border, in points. More...
 
BorderStyle Style
 Border style. Please refer to enumeration Annotations::BorderStyle and this should be one of its values.
 
float32 CloudIntensity
 Intensity of the cloudy effect. More...
 
float32 DashPhase
 Dash phase. More...
 
Array< float32 >^ DashPatterns
 A float array that represents the dash patterns. More...
 

Detailed Description

Class to represent annotation border information.

Property Documentation

float32 Foxit::PDF::Annotations::BorderInfo::CloudIntensity

Intensity of the cloudy effect.

This property is only useful to free text, square, circle, polygon, and polyline annotations when property BorderInfo::Style is BorderStyle::Cloudy.
Suggested values range is from 0 to 2. -1 mean no cloudy border effect.

Array< float32>^ Foxit::PDF::Annotations::BorderInfo::DashPatterns

A float array that represents the dash patterns.

Only useful when property BorderInfo::Style is BorderStyle::Dashed. If the count of elements in this array is above 16, only the first 16 elements are used. The value of elements in this array should not be negative.

float32 Foxit::PDF::Annotations::BorderInfo::DashPhase

Dash phase.

Only useful when property BorderInfo::Style is BorderStyle::Dashed.

float32 Foxit::PDF::Annotations::BorderInfo::Width

Width of border, in points.

If this value is 0, no border is drawn. This value should not be negative.

Foxit Corporation