Search Results for

    Show / Hide Table of Contents

    Interface IDrawContainer

    Represents a container that can hold drawings such as images and shapes.

    Namespace: IronWord.Models.Abstract.Interfaces
    Assembly: IronWord.dll
    Syntax
    public interface IDrawContainer

    IDrawContainer is the contract you reach through whenever a part of a Word document needs to hold pictures and drawn shapes. It is what lets the same drawing calls work on a paragraph, a run, or a whole section, so code that places a logo or a callout box does not care which element it is writing into. Anything that draws is confused with the text-only ITextContainer; a draw container handles images and shapes, while a text container handles runs and strings.

    A developer rarely names this interface directly. You receive it through the concrete types that implement it: Paragraph, Run, and DocumentSection all satisfy IDrawContainer, so you obtain one simply by holding a paragraph or section and calling its drawing methods. The interface belongs to the build-and-edit stage of the render workflow, after the document is open and before it is saved, at the point where visual content is added alongside the words.

    The everyday members are AddImage and AddShape, both of which return the created content so you can position or style it. AddImage has four overloads, accepting an AnyBitmap, an existing ImageContent, a Stream, or a file-path string, and each returns an ImageContent. AddShape takes a ShapeContent and returns it. To read drawings back out, ExtractImages returns a List<ImageContent> and ExtractShapes returns a List<ShapeContent>, which is how you audit or relocate the visuals already in a container.

    IDrawContainer container = paragraph;
    ImageContent logo = container.AddImage("logo.png");

    The add image how-to walks through placing a picture, and the extract images how-to pulls them back out. The document element tutorial shows where containers sit in the object model.

    Methods

    AddImage(AnyBitmap)

    Adds an Image to the draw container from an AnyBitmap instance.

    Declaration
    ImageContent AddImage(AnyBitmap anyBitmap)
    Parameters
    Type Name Description
    IronSoftware.Drawing.AnyBitmap anyBitmap

    The AnyBitmap instance containing the Image data.

    Returns
    Type Description
    ImageContent

    The added Image.

    AddImage(ImageContent)

    Adds an Image to the draw container.

    Declaration
    ImageContent AddImage(ImageContent imageContent)
    Parameters
    Type Name Description
    ImageContent imageContent

    The Image to be added.

    Returns
    Type Description
    ImageContent

    The added Image.

    AddImage(Stream)

    Adds an Image to the draw container from a stream.

    Declaration
    ImageContent AddImage(Stream imageStream)
    Parameters
    Type Name Description
    System.IO.Stream imageStream

    The stream containing the Image data.

    Returns
    Type Description
    ImageContent

    The added Image.

    AddImage(String)

    Adds an Image to the draw container from a file path.

    Declaration
    ImageContent AddImage(string imagePath)
    Parameters
    Type Name Description
    System.String imagePath

    The file path of the Image.

    Returns
    Type Description
    ImageContent

    The added Image.

    AddShape(ShapeContent)

    Adds a Shape to the draw container.

    Declaration
    ShapeContent AddShape(ShapeContent shapeContent)
    Parameters
    Type Name Description
    ShapeContent shapeContent

    The Shape to be added.

    Returns
    Type Description
    ShapeContent

    The added Shape.

    ExtractImages()

    Extract all images from this container

    Declaration
    List<ImageContent> ExtractImages()
    Returns
    Type Description
    System.Collections.Generic.List<ImageContent>

    List of images

    ExtractShapes()

    Extract all shapes from this container

    Declaration
    List<ShapeContent> ExtractShapes()
    Returns
    Type Description
    System.Collections.Generic.List<ShapeContent>

    List of path segment collections

    ☀
    ☾
    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