PdfXmlMetadataStream Class

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

Represents an XML metadata stream.

public sealed class PdfXmlMetadataStream : PdfObject, IEnumerable<XElement>, IEnumerable
Public NotInheritable Class PdfXmlMetadataStream
    Inherits PdfObject
    Implements IEnumerable(Of XElement), IEnumerable
Inheritance:
System.Object
PdfXmlMetadataStream
Implements
System.Collections.Generic.IEnumerable<System.Xml.Linq.XElement>
System.Collections.IEnumerable

Properties

Count

Gets the number of properties in this PdfXmlMetadataStream.

public int Count { get; }
Public ReadOnly Property Count As Integer
Property Value
System.Int32

The number of properties in this PdfXmlMetadataStream.

IsValid

Gets a value indicating whether XML of this PdfXmlMetadataStream is valid.

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

true if XML of this PdfXmlMetadataStream is valid; otherwise, false.

Item[XName]

Gets the property with the specified name.

public XElement this[XName name] { get; }
Public ReadOnly Property Item(name As XName) As XElement
Parameters
name
System.Xml.Linq.XName

The fully qualified name of the property.

Property Value
System.Xml.Linq.XElement

The property with the specified name.

Metadata

A null value because PdfXmlMetadataStream cannot have a metadata of its own.

public override PdfXmlMetadataStream Metadata { get; }
Public Overrides ReadOnly Property Metadata As PdfXmlMetadataStream
Property Value
PdfXmlMetadataStream

A null value.

Overrides
See Also

Value

Gets or sets the XML text of the PdfXmlMetadataStream.

public string Value { get; set; }
Public Property Value As String
Property Value
System.String

The XML text of the PdfXmlMetadataStream.

Methods

Add(XElement)

Adds the specified property to this PdfXmlMetadataStream.

public void Add(XElement property)
Public Sub Add(property As XElement)
Parameters
property
System.Xml.Linq.XElement

The property to add.

Exceptions
System.ArgumentNullException

property is null.

Clear()

Removes the Metadata entry from the parent PdfObject.

public void Clear()
Public Sub Clear

GetEnumerator()

Returns an enumerator that iterates through the properties of this PdfXmlMetadataStream.

public PdfXmlMetadataStream.PropertyEnumerator GetEnumerator()
Public Function GetEnumerator As PdfXmlMetadataStream.PropertyEnumerator
Returns
PdfXmlMetadataStream.PropertyEnumerator

Remove(XName)

Removes the property with the specified name.

public bool Remove(XName name)
Public Function Remove(name As XName) As Boolean
Parameters
name
System.Xml.Linq.XName

The fully qualified name of the property to remove.

Returns
System.Boolean

true if the property is successfully found and removed; otherwise, false. This method returns true if property is not found in the PdfXmlMetadataStream.

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods

See Also