Class WorkbookShapeDataImpl

Summary description for WorkbookShapeDataImpl.

Inheritance
System.Object
CommonObject
WorkbookShapeDataImpl
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.Portable.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<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
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).

AddPicture(MsofbtBSE)

Adds picture to the storage.

Declaration
public int AddPicture(MsofbtBSE picture)
Parameters
Type Name Description
MsofbtBSE picture

Picture to add.
Returns
Type Description
System.Int32

Number of pictures after adding new picture..

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.

FillMsoDgg(MsofbtDgg, WorkbookImpl.ShapesGetterMethod, IdReserver)

Fills MsofbtDgg record.

Declaration
protected void FillMsoDgg(MsofbtDgg dgg, WorkbookImpl.ShapesGetterMethod shapeGetter, IdReserver shapeIds)
Parameters
Type Name Description
MsofbtDgg dgg

Record to fill.
WorkbookImpl.ShapesGetterMethod shapeGetter

Shape getter.
IdReserver shapeIds

GetBlipParams(MsofbtBSE)

Returns BlipParams for picture record.

Declaration
protected static WorkbookShapeDataImpl.BlipParams GetBlipParams(MsofbtBSE bse)
Parameters
Type Name Description
MsofbtBSE bse

MsofbtBSE record to set fields.
Returns
Type Description
WorkbookShapeDataImpl.BlipParams

BlipParams for picture record.

GetPicture(Int32)

Returns picture record.

Declaration
public MsofbtBSE GetPicture(int iPictureId)
Parameters
Type Name Description
System.Int32 iPictureId

Picture index.
Returns
Type Description
MsofbtBSE

Picture record.

ImageFormatToBlipType(ImageFormat)

Converts image format into blip type.

Declaration
public static MsoBlipType ImageFormatToBlipType(ImageFormat format)
Parameters
Type Name Description
ImageFormat format

Format to convert.
Returns
Type Description
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
ImageFormat format

Format to convert.
ExcelImageFormat imageFormat

Desired image format.
Returns
Type Description
MsoBlipType

IsBitmapBlip(MsoBlipType)

Indicates whether blip is bitmap blip.

Declaration
public static bool IsBitmapBlip(MsoBlipType blipType)
Parameters
Type Name Description
MsoBlipType blipType

Blip type to check.
Returns
Type Description
System.Boolean

True if specified blip is bitmap blip; False otherwise.

OnDispose()

Dispose

Declaration
protected override void OnDispose()
Overrides

ParseDrawGroup(MSODrawingGroupRecord)

Parses drawing group record.

Declaration
public void ParseDrawGroup(MSODrawingGroupRecord drawGroup)
Parameters
Type Name Description
MSODrawingGroupRecord drawGroup

Record to parse.

RegisterShapes()

Registers new shapes collection.

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

RemovePicture(UInt32, Boolean)

Removes picture from this collection.

Declaration
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.

SerializeMsoDrawingGroup(OffsetArrayList, TBIFFRecord, IdReserver)

Serializes MsoDrawingGroupRecord if necessary.

Declaration
public void SerializeMsoDrawingGroup(OffsetArrayList records, TBIFFRecord recordCode, IdReserver shapeIds)
Parameters
Type Name Description
OffsetArrayList records

OffsetArrayList that will receive all records.
TBIFFRecord recordCode

Record code for serialization.
IdReserver shapeIds

Implements

System.IDisposable