FOM Reference > Formatting > PDF > fPDFTagArtifact interface
  
fPDFTagArtifact interface
This object defines a PDF Tag Artifact. This object inherits from fPDFTagItem.
ArtifactType enumeration
The type of artifact to create.
The ArtifactType enumeration has the following constants of type int.
TYPE_UNDEFINED = 0
TYPE_PAGINATION = 1
TYPE_LAYOUT = 2
TYPE_PAGE = 3
TYPE_BACKGROUND = 4
ArtifactSubType enumeration
The subtype of a Pagination artifact to create.
The ArtifactSubType enumeration has the following constants of type int.
SUBTYPE_UNDEFINED = 0
SUBTYPE_HEADER = 1
SUBTYPE_FOOTER = 2
SUBTYPE_WATERMARK = 3
attachedBottom attribute
Set to true if the artifact is logically connected to the botttom of the page.
attachedBottom
Access
read-write
Returns
boolean
attachedLeft attribute
Set to true if the artifact is logically connected to the left of the page.
attachedLeft
Access
read-write
Returns
boolean
attachedRight attribute
Set to true if the artifact is logically connected to the right of the page.
attachedRight
Access
read-write
Returns
boolean
attachedTop attribute
Set to true if the artifact is logically connected to the top of the page.
attachedTop
Access
read-write
Returns
boolean
bboxBottom attribute
the bottom of the artifact bounding box in userspace units.
bboxBottom
Access
read-write
Returns
float
bboxLeft attribute
the left of the artifact bounding box in userspace units.
bboxLeft
Access
read-write
Returns
float
bboxRight attribute
the right of the artifact bounding box in userspace units.
bboxRight
Access
read-write
Returns
float
bboxTop attribute
the top of the artifact bounding box in userspace units.
bboxTop
Access
read-write
Returns
float
subtype attribute
For Artifacts with the type fPDFTag.TYPE_PAGINATION, what subtype of artifact to create. Value is one of fPDFTagArtifact-ArtifactSubType.
subtype
Access
read-write
Returns
int
type attribute
what type of artifact to create. Value is one of fPDFTagArtifact-ArtifacType.
type
Access
read-write
Returns
int
fPDFTagArtifact method
Creates a new PDF Tag Artifact.
fPDFTagArtifactname
Parameters
Stringname
The PDF Tag Name.
Returns
fPDFTagArtifact. A new instance of class fPDFTagArtifact.