BackgroundArtifact Class

Class descibes background artifact. This artifact allows to set background of the page.
Inheritance Hierarchy

Namespace:  Aspose.Pdf
Assembly:  Aspose.PDF (in Aspose.PDF.dll) Version: 22.1.0
Syntax
public class BackgroundArtifact : Artifact

The BackgroundArtifact type exposes the following members.

Constructors
  NameDescription
Public methodBackgroundArtifact
Initializes BackgroundArtifact object.
Properties
  NameDescription
Public propertyArtifactHorizontalAlignment
Horizontal alignment of artifact. If position is specified explicitly (in Position property) this value is ignored.
(Inherited from Artifact.)
Public propertyArtifactVerticalAlignment
Vertical alignment of artifact. If position is specified explicitly (in Position property) this value is ignored.
(Inherited from Artifact.)
Public propertyBackgroundColor
Gets or sets bacground color of background artifact
Public propertyBackgroundImage
Gets or sets bacground image of background artifact
Public propertyBottomMargin
Bottom margin of artifact. If position is specified explicitly (in Position property) this value is ignored.
(Inherited from Artifact.)
Public propertyContents
Gets collection of artifact internal operators.
(Inherited from Artifact.)
Public propertyCustomSubtype
Gets name of artifact subtype. May be used if artifact subtype is not standard subtype.
(Inherited from Artifact.)
Public propertyCustomType
Gets name of artifact type. May be used if artifact type is non standard.
(Inherited from Artifact.)
Public propertyForm
Gets XForm of the artifact (if XForm is used).
(Inherited from Artifact.)
Public propertyImage
Gets image of the artifact (if presents).
(Inherited from Artifact.)
Public propertyIsBackground
If true Artifact is placed behind page contents.
(Inherited from Artifact.)
Public propertyLeftMargin
Left margin of artifact. If position is specified explicitly (in Position property) this value is ignored.
(Inherited from Artifact.)
Public propertyLines
Lines of multiline text artifact.
(Inherited from Artifact.)
Public propertyOpacity
Gets or sets opacity of the artifact. Possible values are in range 0..1.
(Inherited from Artifact.)
Public propertyPosition
Gets or sets artifact position. If this property is specified, then margins and alignments are ignored.
(Inherited from Artifact.)
Public propertyRectangle
Gets rectangle of the artifact.
(Inherited from Artifact.)
Public propertyRightMargin
Right margin of artifact. If position is specified explicitly (in Position property) this value is ignored.
(Inherited from Artifact.)
Public propertyRotation
Gets or sets artifact rotation angle.
(Inherited from Artifact.)
Public propertySubtype
Gets artifact subtype. If artifact has non-standard subtype, name of the subtype may be read via CustomSubtype.
(Inherited from Artifact.)
Public propertyText
Gets text of the artifact.
(Inherited from Artifact.)
Public propertyTextState
Text state for artifact text.
(Inherited from Artifact.)
Public propertyTopMargin
Top margin of artifact. If position is specified explicitly (in Position property) this value is ignored.
(Inherited from Artifact.)
Public propertyType
Gets artifact type.
(Inherited from Artifact.)
Methods
  NameDescription
Public methodCode exampleBeginUpdates
Start delated updates. Use this feature if you need make several changes to the same artifact to improve performance. Usually artifact operators are changed anytime when artifact property was changed. This causes changing of page contents everytime when artifact was changed. To avoid this effect put all artifact updates between StartUpdates/SaveUpdates calls. This allows to change page contents only once.
(Inherited from Artifact.)
Public methodDispose
Dispose the artifact.
(Inherited from Artifact.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Gets custom value of artifact.
(Inherited from Artifact.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveValue
Remove custom value from the artifact.
(Inherited from Artifact.)
Public methodSaveUpdates
Saves all updates in artifact which were made after BeginUpdates() call.
(Inherited from Artifact.)
Public methodSetImage(Stream)
Sets image of the artifact.
(Inherited from Artifact.)
Public methodSetImage(String)
Sets image of the artifact.
(Inherited from Artifact.)
Public methodSetLinesAndState
Set text and text properties of the artifact. Allows to specify multiple lines.
(Inherited from Artifact.)
Public methodSetPdfPage
Sets PDF page which is placed on the document page as artifact.
(Inherited from Artifact.)
Public methodSetText
Sets text of the artifact.
(Inherited from Artifact.)
Public methodSetTextAndState
Set text and text properties of the artifact.
(Inherited from Artifact.)
Public methodSetValue
Sets custom value of artifact.
(Inherited from Artifact.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
See Also