Class ContentElement
Represents a base class for all content elements in the content model.
Inheritance
System.Object
ContentElement
Implements
IronSoftware.Abstractions.IDocumentElement
IronSoftware.IDocumentObject
System.ICloneable
Namespace: IronWord.Models.Abstract
Assembly: IronWord.dll
Syntax
public abstract class ContentElement : Object, IDocumentElement, IDocumentObject, ICloneable
Constructors
ContentElement()
Initializes a new instance of the ContentElement class.
Declaration
protected ContentElement()
Fields
Status
Gets or sets the status of the element, indicating whether it is new, updated, or deleted.
Declaration
public ElementStatus Status
Field Value
| Type | Description |
|---|---|
| ElementStatus |
Properties
DocumentId
Declaration
public IDocumentId DocumentId { get; set; }
Property Value
| Type | Description |
|---|---|
| IronSoftware.IDocumentId |
ObjNum
Declaration
public uint ObjNum { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
PageIndex
Declaration
public uint PageIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
Parent
Gets the parent element of this element.
Declaration
public ParentElement Parent { get; }
Property Value
| Type | Description |
|---|---|
| ParentElement |
Methods
Clone()
Creates a copy of the ContentElement.
Declaration
public virtual object Clone()
Returns
| Type | Description |
|---|---|
| System.Object | A new instance of the Shape with all properties copied. |
CloneObject()
Declaration
protected virtual object CloneObject()
Returns
| Type | Description |
|---|---|
| System.Object |
GetIndex<T>()
Gets the index of this element within its parent's list of child elements of the same type.
Declaration
protected int GetIndex<T>()
where T : ContentElement
Returns
| Type | Description |
|---|---|
| System.Int32 | The index of this element, or 0 if it has no parent. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of the element and its siblings. |
Remove()
Marks this element as deleted.
Declaration
public virtual void Remove()
Replace(ContentElement)
Replaces the current element with a new child element into same position within parent.
Declaration
public void Replace(ContentElement newChild)
Parameters
| Type | Name | Description |
|---|---|---|
| ContentElement | newChild | The new child element to replace the current element. |
Implements
IronSoftware.Abstractions.IDocumentElement
IronSoftware.IDocumentObject
System.ICloneable