File Formats

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class WorkbookShapeDataImpl

    Show / Hide Table of Contents

    Class WorkbookShapeDataImpl

    Summary description for WorkbookShapeDataImpl.

    Inheritance
    System.Object
    CommonObject
    WorkbookShapeDataImpl
    Implements
    IParentApplication
    System.IDisposable
    ICloneParent
    Inherited Members
    CommonObject.m_bIsDisposed
    CommonObject.FindParent(Type)
    CommonObject.FindParent(Type, Boolean)
    CommonObject.FindParent(Object, Type)
    CommonObject.FindParent(Object, Type, Boolean)
    CommonObject.FindParents(Type[])
    CommonObject.FindParent(Type[])
    CommonObject.SetParent(Object)
    CommonObject.CheckDisposed()
    CommonObject.AddReference()
    CommonObject.ReleaseReference()
    CommonObject.Dispose()
    CommonObject.Application
    CommonObject.Parent
    CommonObject.AppImplementation
    CommonObject.ReferenceCount
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.XlsIO.Implementation
    Assembly: Syncfusion.XlsIO.Base.dll
    Syntax
    public class WorkbookShapeDataImpl : CommonObject, IParentApplication, IDisposable, ICloneParent

    Constructors

    WorkbookShapeDataImpl(IApplication, Object, WorkbookImpl.ShapesGetterMethod)

    Initializes new instance.

    Declaration
    public WorkbookShapeDataImpl(IApplication application, object parent, WorkbookImpl.ShapesGetterMethod shapeGetter)
    Parameters
    Type Name Description
    IApplication application

    Application object for the new instance.

    System.Object parent

    Parent object for the new instance.

    WorkbookImpl.ShapesGetterMethod shapeGetter

    Shape getter to use for retrieving shapes from worksheet.

    Properties

    NeedMsoDrawingGroup

    Indicates whether this mso drawing group has to be serialized.

    Declaration
    protected bool NeedMsoDrawingGroup { get; }
    Property Value
    Type Description
    System.Boolean

    Pictures

    List with all pictures. Read-only.

    Declaration
    public List<MsofbtBSE> Pictures { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<Syncfusion.XlsIO.Parser.Biff_Records.MsoDrawing.MsofbtBSE>

    Methods

    AddPicture(Image, ExcelImageFormat, String)

    Adds picture to the storage.

    Declaration
    public int AddPicture(Image image, ExcelImageFormat imageFormat, string strPictureName)
    Parameters
    Type Name Description
    System.Drawing.Image image

    Picture to add.

    ExcelImageFormat imageFormat

    Desired image format.

    System.String strPictureName

    Name of the picture.

    Returns
    Type Description
    System.Int32

    Number of pictures after adding new picture (blip id).

    Clear()

    Clears all internal data.

    Declaration
    public void Clear()

    ClearPreservedClusters()

    Clear preserved clusters

    Declaration
    public void ClearPreservedClusters()

    Clone(Object)

    Creates a new object that is a copy of the current instance.

    Declaration
    public object Clone(object parent)
    Parameters
    Type Name Description
    System.Object parent

    Parent object for a copy of this instance.

    Returns
    Type Description
    System.Object

    A new object that is a copy of this instance.

    GetPicture(Int32)

    Returns picture record.

    Declaration
    [CLSCompliant(false)]
    public MsofbtBSE GetPicture(int iPictureId)
    Parameters
    Type Name Description
    System.Int32 iPictureId

    Picture index.

    Returns
    Type Description
    Syncfusion.XlsIO.Parser.Biff_Records.MsoDrawing.MsofbtBSE

    Picture record.

    ImageFormatToBlipType(ImageFormat)

    Converts image format into blip type.

    Declaration
    public static MsoBlipType ImageFormatToBlipType(ImageFormat format)
    Parameters
    Type Name Description
    System.Drawing.Imaging.ImageFormat format

    Format to convert.

    Returns
    Type Description
    Syncfusion.XlsIO.Parser.Biff_Records.MsoDrawing.MsoBlipType

    Returns appropriate image format.

    ImageFormatToBlipType(ImageFormat, ExcelImageFormat)

    Converts image format into blip type.

    Declaration
    public static MsoBlipType ImageFormatToBlipType(ImageFormat format, ExcelImageFormat imageFormat)
    Parameters
    Type Name Description
    System.Drawing.Imaging.ImageFormat format

    Format to convert.

    ExcelImageFormat imageFormat

    Desired image format.

    Returns
    Type Description
    Syncfusion.XlsIO.Parser.Biff_Records.MsoDrawing.MsoBlipType

    OnDispose()

    Dispose

    Declaration
    protected override void OnDispose()
    Overrides
    CommonObject.OnDispose()

    RegisterShapes()

    Registers new shapes collection.

    Declaration
    public int RegisterShapes()
    Returns
    Type Description
    System.Int32

    RemovePicture(UInt32, Boolean)

    Removes picture from this collection.

    Declaration
    [CLSCompliant(false)]
    public void RemovePicture(uint id, bool removeImage)
    Parameters
    Type Name Description
    System.UInt32 id

    Picture id to remove.

    System.Boolean removeImage

    Indicates whether to remove image (not picture shape) from workbook if we didn't detect any reference to it.

    Implements

    IParentApplication
    System.IDisposable
    ICloneParent
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved