PdfContentMarkTag Struct

Namespace:
GemBox.Pdf.Content.Marked
Assembly:
GemBox.Pdf.dll

Represents the role or significance of the marked-content element.

All tags shall be registered with Adobe Systems (see Annex E) to avoid conflicts between different applications marking the same content stream.

public struct PdfContentMarkTag : IEquatable<PdfContentMarkTag>
Public Structure PdfContentMarkTag
    Implements IEquatable(Of PdfContentMarkTag)
Implements
System.IEquatable<PdfContentMarkTag>

Constructors

PdfContentMarkTag(PdfContentMarkTagRole)

Initializes a new instance of the PdfContentMarkTag structure from the specified PdfContentMarkTagRole value.

public PdfContentMarkTag(PdfContentMarkTagRole value)
Public Sub New(value As PdfContentMarkTagRole)
Parameters
value
PdfContentMarkTagRole
Exceptions
System.NotSupportedException

Value Unknown of enumeration PdfContentMarkTagRole is not supported in the requested operation.

PdfContentMarkTag(String)

Initializes a new instance of the PdfContentMarkTag structure from the specified System.String value.

public PdfContentMarkTag(string value)
Public Sub New(value As String)
Parameters
value
System.String

The System.String value.

Exceptions
System.ArgumentNullException

value is null.

Properties

Role

Gets the role of the marked-content tag as specified in the various parts of PDF Specification ISO 32000-1:2008 or Unknown if the role is unknown.

public readonly PdfContentMarkTagRole Role { get; }
Public ReadOnly Property Role As PdfContentMarkTagRole
Property Value
PdfContentMarkTagRole

The role of the marked-content tag as specified in the various parts of PDF Specification ISO 32000-1:2008 or Unknown if the role is unknown.

Methods

Equals(PdfContentMarkTag)

Determines whether the other PdfContentMarkTag is equal to this PdfContentMarkTag instance.

public bool Equals(PdfContentMarkTag other)
Public Function Equals(other As PdfContentMarkTag) As Boolean
Parameters
other
PdfContentMarkTag

The other marked content tag to compare with this marked content tag instance.

Returns
System.Boolean

true if the other PdfContentMarkTag is equal to this PdfContentMarkTag instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this PdfContentMarkTag instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this marked content tag instance.

Returns
System.Boolean

true if the specified System.Object is a PdfContentMarkTag and is equal to this PdfContentMarkTag instance; otherwise, false.

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this PdfContentMarkTag instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this PdfContentMarkTag instance.

Overrides
System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this PdfContentMarkTag instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this PdfContentMarkTag instance.

Overrides
System.ValueType.ToString()

Operators

Equality(PdfContentMarkTag, PdfContentMarkTag)

Determines whether first and second PdfContentMarkTags are equal.

public static bool operator ==(PdfContentMarkTag first, PdfContentMarkTag second)
Public Shared Operator =(first As PdfContentMarkTag, second As PdfContentMarkTag) As Boolean
Parameters
first
PdfContentMarkTag

The first marked content tag.

second
PdfContentMarkTag

The second marked content tag.

Returns
System.Boolean

true if first and second marked content tags are equal; otherwise, false.

Inequality(PdfContentMarkTag, PdfContentMarkTag)

Determines whether first and second PdfContentMarkTags are not equal.

public static bool operator !=(PdfContentMarkTag first, PdfContentMarkTag second)
Public Shared Operator <>(first As PdfContentMarkTag, second As PdfContentMarkTag) As Boolean
Parameters
first
PdfContentMarkTag

The first marked content tag.

second
PdfContentMarkTag

The second marked content tag.

Returns
System.Boolean

true if first and second marked content tags are not equal; otherwise, false.

Implements

System.IEquatable<T>

Examples

See Also