XmpNode

XmpNode Public class

Description

A node in the internally XMP tree, which can be a schema node, a property node, an array node, an array item, a struct node or a qualifier node (without '?').

        Possible improvements:
        
        1. The kind Node of node might be better represented by a class-hierarchy of different nodes.
        2. The array type should be an enum
        3. isImplicitNode should be removed completely and replaced by return values of fi.
        4. hasLanguage, hasType should be automatically maintained by XMPNode
        
        @since 21.02.2006

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph iTextSharp.xmp.impl
  iTextSharp.xmp.impl.XmpNode[[XmpNode]]
  end
  subgraph System
System.IComparable[[IComparable]]
System.ICloneable[[ICloneable]]
  end
System.IComparable --> iTextSharp.xmp.impl.XmpNode
System.ICloneable --> iTextSharp.xmp.impl.XmpNode

Members

Properties

Public properties

Internal properties

Methods

Public methods

Protected internal methods

Details

Summary

A node in the internally XMP tree, which can be a schema node, a property node, an array node, an array item, a struct node or a qualifier node (without '?').

        Possible improvements:
        
        1. The kind Node of node might be better represented by a class-hierarchy of different nodes.
        2. The array type should be an enum
        3. isImplicitNode should be removed completely and replaced by return values of fi.
        4. hasLanguage, hasType should be automatically maintained by XMPNode
        
        @since 21.02.2006

Inheritance

• IComparable
• ICloneable

Constructors

XmpNode [1/2]

public XmpNode(string name, string value, PropertyOptions options)

Arguments

Summary

Creates an

XMPNode

XmpNode [2/2]

public XmpNode(string name, PropertyOptions options)

Arguments

Summary

Constructor for the node without value.

Methods

Clone

public virtual object Clone()

CompareTo

public virtual int CompareTo(object xmpNode)

Arguments

Clear

public virtual void Clear()

Summary

Resets the node.

GetChild

public virtual XmpNode GetChild(int index)

Arguments

Returns

Returns the child with the requested index.

AddChild [1/2]

public virtual void AddChild(XmpNode node)

Arguments

Summary

Adds a node as child to this node.

Exceptions

AddChild [2/2]

public virtual void AddChild(int index, XmpNode node)

Arguments

Summary

Adds a node as child to this node.

Exceptions

ReplaceChild

public virtual void ReplaceChild(int index, XmpNode node)

Arguments

Summary

Replaces a node with another one.

RemoveChild [1/2]

public virtual void RemoveChild(int itemIndex)

Arguments

Summary

Removes a child at the requested index.

RemoveChild [2/2]

public virtual void RemoveChild(XmpNode node)

Arguments

Summary

Removes a child node. If its a schema node and doesn't have any children anymore, its deleted.

CleanupChildren

protected internal virtual void CleanupChildren()

Summary

Removes the children list if this node has no children anymore; checks if the provided node is a schema node and doesn't have any children anymore, its deleted.

RemoveChildren

public virtual void RemoveChildren()

Summary

Removes all children from the node.

FindChildByName

public virtual XmpNode FindChildByName(string expr)

Arguments

Returns

Returns an

XMPNode

if node has been found,

null

GetQualifier

public virtual XmpNode GetQualifier(int index)

Arguments

Returns

Returns the qualifier with the requested index.

AddQualifier

public virtual void AddQualifier(XmpNode qualNode)

Arguments

Summary

Appends a qualifier to the qualifier list and sets respective options.

Exceptions

RemoveQualifier

public virtual void RemoveQualifier(XmpNode qualNode)

Arguments

Summary

Removes one qualifier node and fixes the options.

RemoveQualifiers

public virtual void RemoveQualifiers()

Summary

Removes all qualifiers from the node and sets the options appropriate.

FindQualifierByName

public virtual XmpNode FindQualifierByName(string expr)

Arguments

Returns

Returns a qualifier

XMPNode

if node has been found,

null

HasChildren

public virtual bool HasChildren()

Returns

Returns whether the node has children.

IterateChildren

public virtual IEnumerator IterateChildren()

Returns

Returns an iterator for the children. Note: take care to use it.remove(), as the flag are not adjusted in that case.

HasQualifier

public virtual bool HasQualifier()

Returns

Returns whether the node has qualifier attached.

IterateQualifier

public virtual IEnumerator IterateQualifier()

Returns

Returns an iterator for the qualifier. Note: take care to use it.remove(), as the flag are not adjusted in that case.

CloneSubtree

public virtual void CloneSubtree(XmpNode destination)

Arguments

Summary

Performs a deep clone of the complete subtree (children and qualifier )into and add it to the destination node.

DumpNode

public virtual string DumpNode(bool recursive)

Arguments

Summary

Renders this node and the tree unter this node in a human readable form.

Returns

Returns a multiline string containing the dump.

Sort

public virtual void Sort()

Properties

Parent

public virtual XmpNode Parent { get; set; }

ChildrenLength

public virtual int ChildrenLength { get; }

QualifierLength

public virtual int QualifierLength { get; }

Name

public virtual string Name { get; set; }

Value

public virtual string Value { get; set; }

Options

public virtual PropertyOptions Options { get; set; }

Implicit

public virtual bool Implicit { get; set; }

HasAliases

public virtual bool HasAliases { get; set; }

Alias

public virtual bool Alias { get; set; }

HasValueChild

public virtual bool HasValueChild { get; set; }

Children

internal IList Children { get; }

Summary

Note: This method should always be called when accessing 'children' to be sure that its initialized.

UnmodifiableChildren

public virtual IList UnmodifiableChildren { get; }

Generated with ModularDoc