PdfBasicContainer Class

Namespace:
GemBox.Pdf.Objects
Assembly:
GemBox.Pdf.dll

Represents a base class for all mutable basic PDF objects.

public abstract class PdfBasicContainer : PdfBasicObject
Public MustInherit Class PdfBasicContainer
    Inherits PdfBasicObject
Inheritance:
System.Object
PdfBasicContainer
Derived
PdfBasicCollection
PdfIndirectObject
PdfStream
Remarks

PdfBasicContainer instance is mutable and therefore cannot be shared (contained in multiple PdfDictionary or PdfArray objects). The only exception is PdfIndirectObject instance that is also mutable, but can be shared.

PdfBasicContainer instance is not thread-safe.

PdfBasicContainer instance implements reference equality.

Properties

Indirect

Gets the PdfIndirectObject if this PdfBasicContainer is Value or null otherwise.

public PdfIndirectObject Indirect { get; }
Public ReadOnly Property Indirect As PdfIndirectObject
Property Value
PdfIndirectObject

The PdfIndirectObject if this PdfBasicContainer is Value or null otherwise.

See Also

IsReadOnly

Gets a value indicating whether the PdfBasicContainer and all of its descendants are read-only.

public bool IsReadOnly { get; }
Public ReadOnly Property IsReadOnly As Boolean
Property Value
System.Boolean

true if the PdfBasicContainer and all of its descendants are read-only; otherwise, false.

Methods

Clone(Boolean)

Makes a deep clone of the PdfBasicContainer with optionally cloning descendant PdfIndirectObjects.

public PdfBasicContainer Clone(bool shallowIndirect)
Public Function Clone(shallowIndirect As Boolean) As PdfBasicContainer
Parameters
shallowIndirect
System.Boolean

if set to true descendant PdfIndirectObjects won't be cloned.

Returns
PdfBasicContainer

A deep clone of the PdfBasicContainer.

Clone(Func<PdfIndirectObject, PdfBasicObject>)

Makes a deep clone of the PdfBasicContainer with parameter that controls the cloning of PdfIndirectObjects.

public PdfBasicContainer Clone(Func<PdfIndirectObject, PdfBasicObject> indirectObjectClone)
Public Function Clone(indirectObjectClone As Func(Of PdfIndirectObject, PdfBasicObject)) As PdfBasicContainer
Parameters
indirectObjectClone
System.Func<PdfIndirectObject, PdfBasicObject>

A parameter that controls the cloning of PdfIndirectObjects.

Returns
PdfBasicContainer

A deep clone of the PdfBasicContainer.

Equals(Object)

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

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

The System.Object to compare with this PdfBasicContainer instance.

Returns
System.Boolean

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

Overrides
System.Object.Equals(System.Object)

GetHashCode()

Returns a hash code for this PdfBasicContainer instance.

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

A hash code for this PdfBasicContainer instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides
System.Object.GetHashCode()

Inherited Properties

Null

Gets the single instance of Null type.

(Inherited from PdfBasicObject)

ObjectType

Gets the PdfBasicObjectType of the current PdfBasicObject instance.

(Inherited from PdfBasicObject)

Inherited Methods

ToString()

Returns a System.String that represents this PdfBasicObject instance.

(Inherited from PdfBasicObject)