Aspose::Pdf::Artifact class
Contents
[
Hide
]Artifact class
Class represents PDF Artifact object.
class Artifact : public System::IDisposable
Enums
| Enum | Description |
|---|---|
| ArtifactSubtype | Enumeration of possible artifacts subtype. |
| ArtifactType | Enumeration of possuble artifact types. |
Methods
| Method | Description |
|---|---|
| Artifact(System::String, System::String) | Constructor of artifact with specified type and subtype. |
| Artifact(Artifact::ArtifactType, Artifact::ArtifactSubtype) | Constructor of artifact with specified type and subtype. |
| BeginUpdates() | 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. |
| Dispose() override | Dispose the artifact. |
| get_ArtifactHorizontalAlignment() const | Horizontal alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| get_ArtifactVerticalAlignment() const | Vertical alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| get_BottomMargin() const | Bottom margin of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| get_Contents() | Gets collection of artifact internal operators. |
| get_CustomSubtype() | Gets name of artifact subtype. May be used if artifact subtype is not standard subtype. |
| get_CustomType() | Gets name of artifact type. May be used if artifact type is non standard. |
| get_Form() | Gets XForm of the artifact (if XForm is used). |
| get_Image() | Gets image of the artifact (if presents). |
| get_IsBackground() const | If true Artifact is placed behind page contents. |
| get_LeftMargin() const | Left margin of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| get_Lines() | Lines of multiline text artifact. |
| get_Opacity() const | Gets opacity of the artifact. Possible values are in range 0..1. |
| get_Position() const | Gets artifact position. If this property is specified, then margins and alignments are ignored. |
| get_Rectangle() | Gets rectangle of the artifact. |
| get_RightMargin() const | Right margin of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| get_Rotation() | Gets artifact rotation angle. |
| get_Subtype() | Gets artifact subtype. If artifact has non-standard subtype, name of the subtype may be read via CustomSubtype. |
| get_Text() | Gets text of the artifact. |
| get_TextState() | Text state for artifact text. |
| get_TopMargin() const | Top margin of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| get_Type() | Gets artifact type. |
| GetValue(System::String) | Gets custom value of artifact. |
| RemoveValue(System::String) | Remove custom value from the artifact. |
| SaveUpdates() | Saves all updates in artifact which were made after BeginUpdates() call. |
| set_ArtifactHorizontalAlignment(HorizontalAlignment) | Horizontal alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| set_ArtifactVerticalAlignment(VerticalAlignment) | Vertical alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| set_BottomMargin(double) | Bottom margin of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| set_CustomSubtype(System::String) | Gets name of artifact subtype. May be used if artifact subtype is not standard subtype. |
| set_CustomType(System::String) | Gets name of artifact type. May be used if artifact type is non standard. |
| set_IsBackground(bool) | If true Artifact is placed behind page contents. |
| set_LeftMargin(double) | Left margin of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| set_Opacity(double) | Sets opacity of the artifact. Possible values are in range 0..1. |
| set_Position(System::SharedPtr<Point>) | Sets artifact position. If this property is specified, then margins and alignments are ignored. |
| set_RightMargin(double) | Right margin of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| set_Rotation(double) | Sets artifact rotation angle. |
| set_Subtype(Artifact::ArtifactSubtype) | Gets artifact subtype. If artifact has non-standard subtype, name of the subtype may be read via CustomSubtype. |
| set_Text(System::String) | Gets text of the artifact. |
| set_TextState(System::SharedPtr<Aspose::Pdf::Text::TextState>) | Text state for artifact text. |
| set_TopMargin(double) | Top margin of artifact. If position is specified explicitly (in Position property) this value is ignored. |
| set_Type(Artifact::ArtifactType) | Gets artifact type. |
| SetImage(System::SharedPtr<System::IO::Stream>) | Sets image of the artifact. |
| SetImage(System::String) | Sets image of the artifact. |
| SetLinesAndState(System::ArrayPtr<System::String>, System::SharedPtr<Aspose::Pdf::Text::TextState>) | Set text and text properties of the artifact. Allows to specify multiple lines. |
| SetPageNumberReplacementString(System::String) | Sets what string will be replaced with the page number. The default value is #. |
| SetPdfPage(System::SharedPtr<Page>) | Sets PDF page which is placed on the document page as artifact. |
| SetText(System::SharedPtr<Facades::FormattedText>) | Sets text of the artifact. |
| SetTextAndState(System::String, System::SharedPtr<Aspose::Pdf::Text::TextState>) | Set text and text properties of the artifact. |
| SetValue(System::String, System::String) | Sets custom value of artifact. |
See Also
- Class IDisposable
- Namespace Aspose::Pdf
- Library Aspose.PDF for C++