PdfContentMark Class

Namespace:: GemBox.Pdf.Content

Assembly:: GemBox.Pdf.dll

Represents a mark used to distinguish the part of the PDF content.

C#
VB.NET

public sealed class PdfContentMark : PdfContentElement

Public NotInheritable Class PdfContentMark
    Inherits PdfContentElement

Inheritance:: System.Object
PdfContentElement
PdfContentMark

Properties

AssociatedFiles

(Optional; PDF 2.0) An array of one or more PdfFileSpecifications which denote the associated files for content marked with this PdfContentMark.

C#
VB.NET

public PdfAssociatedFileCollection AssociatedFiles { get; }

Public ReadOnly Property AssociatedFiles As PdfAssociatedFileCollection

Property Value

PdfAssociatedFileCollection

An array of one or more PdfFileSpecifications which denote the associated files for content marked with this PdfContentMark.

ElementType

Gets the Mark value.

C#
VB.NET

public override PdfContentElementType ElementType { get; }

Public Overrides ReadOnly Property ElementType As PdfContentElementType

Property Value

PdfContentElementType

The Mark value.

Overrides

PdfContentElement.ElementType

MarkType

Gets the type of the content mark.

C#
VB.NET

public PdfContentMarkType MarkType { get; }

Public ReadOnly Property MarkType As PdfContentMarkType

Property Value

PdfContentMarkType

The type of the content mark.

Properties

Gets or sets the marked content properties.

The Properties of the End mark is retrieved from and set to the associated Start mark.

Use GetDictionary(PdfObject) on the returned PdfContentMarkProperties to get the underlying PdfDictionary that contains the actual properties.

If PdfContentMarkProperties value doesn't contain any PdfIndirectObject, it is set as a read-only when reading/writing the Properties from/to the underlying content stream and when setting the Properties to a new value. This is required to correctly detect content changes.

Use GetEditableProperties() method to get PdfContentMarkProperties that you want to edit.

C#
VB.NET

public PdfContentMarkProperties Properties { get; set; }

Public Property Properties As PdfContentMarkProperties

Property Value

PdfContentMarkProperties

The marked content properties.

Remarks

If PdfContentMarkProperties value that is being set is associated with another PdfDocument, this property setter will automatically clone it and associate the clone with the current PdfDocument.

Tag

Gets or sets the marked content tag.

The Tag of the End mark is retrieved from and set to the associated Start mark.

C#
VB.NET

public PdfContentMarkTag Tag { get; set; }

Public Property Tag As PdfContentMarkTag

Property Value

PdfContentMarkTag

The marked content tag.

Methods

GetEditableProperties()

Gets the marked content properties that can edited.

The GetEditableProperties() of the End mark is retrieved from the associated Start mark.

Use GetDictionary(PdfObject) on the returned PdfContentMarkProperties to get the underlying PdfDictionary that contains the actual editable properties.

Use this method only if you want to edit Properties; otherwise, use Properties.

C#
VB.NET

public PdfContentMarkProperties GetEditableProperties()

Public Function GetEditableProperties As PdfContentMarkProperties

Returns

PdfContentMarkProperties

The marked content properties that can edited.

ToString()

Returns a System.String that represents this PdfContentMark instance.

C#
VB.NET

public override string ToString()

Public Overrides Function ToString As String

Returns

System.String

A System.String that represents this PdfContentMark instance.

Overrides

System.Object.ToString()

Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).