Search Results for

    Show / Hide Table of Contents

    Class ContentElement

    Represents a base class for all content elements in the content model.

    Inheritance
    System.Object
    ContentElement
    ParentElement
    Break
    Chart
    ImageContent
    ListLevel
    ShapeContent
    TextContent
    Implements
    IronSoftware.Abstractions.Word.IWordDocumentObject
    IronSoftware.Abstractions.IDocumentObject
    System.ICloneable
    Namespace: IronWord.Models.Abstract
    Assembly: IronWord.dll
    Syntax
    public abstract class ContentElement : Object

    Working with any piece of content in an IronWord document through one shared shape in C# is what ContentElement makes possible. A paragraph, a run, a table, an image, a shape, and a chart are all content elements, so this base is what lets the library treat the body of a document as one uniform tree of nodes that can be located, moved, and replaced. You rarely name ContentElement directly in everyday code, but understanding it explains why elements share the same handful of positioning operations.

    Concrete elements such as Break, Chart, Image, ImageContent, Shape, ShapeContent, and TextContent derive from it, and so do the parent-side bases ParentElement and TextContentElement. Once an element has been added to a document it gains a Parent, which points at the ParentElement that holds it, so a node always knows where it sits in the tree. The Status property records whether the element is new, updated, or unchanged, which the save pipeline reads when it writes the file back.

    The members that matter day to day are the editing operations every element inherits. Remove detaches the element from its parent, Replace swaps in a new child at the same position, and Clone returns a deep copy you can place elsewhere. GetIndex<T> reports where the element falls among siblings of its own type. Because these live on the base, the same call works whether you hold an image, a paragraph, or a table, which keeps editing logic short.

    using IronWord;
    using IronWord.Models;
    
    WordDocument doc = new WordDocument("input.docx");
    foreach (Paragraph paragraph in doc.Paragraphs)
        paragraph.Remove();
    doc.Save("trimmed.docx");

    The edit text how-to walks through changing element content, the remove text how-to shows detaching nodes, and the document element tutorial maps the whole tree.

    Constructors

    ContentElement()

    Initializes a new instance of the ContentElement class.

    Declaration
    protected ContentElement()

    Properties

    Parent

    Gets the parent element of this element.

    Declaration
    public ParentElement Parent { get; }
    Property Value
    Type Description
    ParentElement

    Status

    Gets or sets the status of the element, indicating whether it is new, updated, or deleted.

    Declaration
    public ElementStatus Status { get; set; }
    Property Value
    Type Description
    IronSoftware.Abstractions.Word.ElementStatus

    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()

    Declaration
    public virtual void Remove()

    Replace(IWordDocumentObject)

    Replaces the current element with a new child element into same position within parent.

    Declaration
    public void Replace(IWordDocumentObject newChild)
    Parameters
    Type Name Description
    IronSoftware.Abstractions.Word.IWordDocumentObject newChild

    The new child element to replace the current element.

    Implements

    IronSoftware.Abstractions.Word.IWordDocumentObject
    IronSoftware.Abstractions.IDocumentObject
    System.ICloneable
    ☀
    ☾
    Downloads
    • Download with NuGet
    • Start for Free
    In This Article
    Back to top
    Install with NuGet
    IronWord_for_dotnet_log2o
    Blue key in circleGet started for FREE
    No credit card required
    Test in a live environment

    Test in production without watermarks.
    Works wherever you need it to.

    Fully-functional product

    Get 30 days of fully functional product.
    Have it up and running in minutes.

    24/5 technical support

    Full access to our support engineering team during your product trial

    Grey key in circleGet started for FREE
    The trial form was submitted successfully.
    Calendar in circleBook Free Live Demo
    No contact, no card details, no commitments Book a 30-minute, personal demo.
    Here's what to expect:

    A live demo of our product and its key features

    Get project specific feature recommendations

    All your questions are answered to make sure you have all the information you need. (No commitment whatsoever.)

    Grey key in circleBook Free Live Demo
    Your booking has been completed Check your e-mail for confirmation
    Support Team Member 6 related to The C# PDF Library Support Team Member 14 related to The C# PDF Library Support Team Member 4 related to The C# PDF Library Support Team Member 2 related to The C# PDF Library
    Online 24/5
    Need help? Our sales team would be glad to help you.
    Try the Enterprise Trial
    ironpdf_for_dotnet_log2o
    Key in blue circle
    Get your free 30-day Trial Key instantly.
    bullet_checkedNo credit card or account creation required
    Key in blue circle
    Get your free 30-day Trial Key instantly.
    Blue key in circleNo credit card or account creation required
    Green Check in orange circle
    The trial form was submitted successfully.
    badge_greencheck_in_yellowcircle
    Thank you for starting a trial

    Please check your email for the trial license key.

    If you don’t receive an email, please start a live chat or email support@ironsoftware.com

    Install with NuGet
    View Licensing
    • Logo Aetna
    • Logo NASA
    • Logo GE
    • Logo Porsche
    • Logo USDA
    • Logo Qatar
    Join Millions of Engineers who’ve tried IronWord