Class XmpEntityBase

Base class for the xmp entities.

Inheritance

System.Object

XmpEntityBase

XmpSchema

XmpType

Namespace: Syncfusion.Pdf.Xmp

Assembly: Syncfusion.Pdf.Portable.dll

Syntax

public abstract class XmpEntityBase : Object

Constructors

XmpEntityBase(XNode, String, String, String)

Initializes a new instance of the XmpEntityBase class.

Declaration

protected XmpEntityBase(XNode parent, string prefix, string localName, string namespaceURI)

Parameters

Type	Name	Description
System.Xml.Linq.XNode	parent	The parent.
System.String	prefix	The prefix.
System.String	localName	Name of the local.
System.String	namespaceURI	The namespace URI.

Properties

EntityName

Gets name of the entity's tag.

Declaration

protected string EntityName { get; }

Property Value

Type	Description
System.String

EntityNamespaceURI

Gets URI of the entity's namespace.

Declaration

protected string EntityNamespaceURI { get; }

Property Value

Type	Description
System.String

EntityParent

Gets parent xml node for the entity.

Declaration

protected XElement EntityParent { get; }

Property Value

Type	Description
System.Xml.Linq.XElement

EntityPrefix

Gets namespace prefix of the entity.

Declaration

protected string EntityPrefix { get; }

Property Value

Type	Description
System.String

Exists

Gets a value indicating whether this XmpEntityBase is exists.

Declaration

protected bool Exists { get; }

Property Value

Type	Description
System.Boolean	true if exists; otherwise, false.

SuspendInitialization

Gets a value indicating whether [suspend initialization].

Declaration

protected bool SuspendInitialization { get; }

Property Value

Type	Description
System.Boolean

XmlData

Gets Xml data of the entity.

Declaration

public XElement XmlData { get; }

Property Value

Type	Description
System.Xml.Linq.XElement

Methods

CheckIfExists()

Checks whether entity already exists in the parent.

Declaration

protected virtual bool CheckIfExists()

Returns

Type	Description
System.Boolean	True - if exists, False otherwise.

CreateEntity()

Creates entity in the parent.

Declaration

protected abstract void CreateEntity()

GetEntityXml()

Gets Xml data of the entity.

Declaration

protected abstract XElement GetEntityXml()

Returns

Type	Description
System.Xml.Linq.XElement	XmlElement containing entity data.

GetSuspend()

Gets value indicating whether we have to suspend initialization.

Declaration

protected virtual bool GetSuspend()

Returns

Type	Description
System.Boolean	Value indicating whether we have to suspend initialization.

Initialize()

Initializes object.

Declaration

protected virtual void Initialize()