Class ShapeCollectionBase
Summary description for ShapeCollectionBase.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public abstract class ShapeCollectionBase : CollectionBaseEx<IShape>, IList<IShape>, ICollection<IShape>, IEnumerable<IShape>, IEnumerable, IParentApplication, ICloneParent
Constructors
ShapeCollectionBase(IApplication, Object)
Declaration
public ShapeCollectionBase(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | |
System.Object | parent |
ShapeCollectionBase(IApplication, Object, MsofbtSpgrContainer, ExcelParseOptions)
Declaration
public ShapeCollectionBase(IApplication application, object parent, MsofbtSpgrContainer container, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | |
System.Object | parent | |
MsofbtSpgrContainer | container | |
ExcelParseOptions | options | Parse options. |
Fields
DEF_ID_PER_GROUP
Default id increment when group changes.
Declaration
public const int DEF_ID_PER_GROUP = 1024
Field Value
Type |
---|
System.Int32 |
DEF_SHAPES_ROUND_VALUE
Shapes count would be rounded to this value.
Declaration
public const int DEF_SHAPES_ROUND_VALUE = 1024
Field Value
Type |
---|
System.Int32 |
m_sheet
Parent worksheet.
Declaration
protected WorksheetBaseImpl m_sheet
Field Value
Type |
---|
WorksheetBaseImpl |
Properties
Item[Int32]
Returns single shape from the collection by its index. Read-only.
Declaration
public IShape this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Property Value
Type |
---|
IShape |
Item[String]
Returns single shape from the collection by its name or null when cannot find. Read-only.
Declaration
public IShape this[string strShapeName] { get; }
Parameters
Type | Name | Description |
---|---|---|
System.String | strShapeName |
Property Value
Type |
---|
IShape |
RecordCode
Code of the Biff record in which all data is stored. Read-only.
Declaration
public abstract TBIFFRecord RecordCode { get; }
Property Value
Type |
---|
TBIFFRecord |
ShapeData
Returns shared shape data for all shapes in this collection. Read-only.
Declaration
public abstract WorkbookShapeDataImpl ShapeData { get; }
Property Value
Type |
---|
WorkbookShapeDataImpl |
ShapesCount
Declaration
public int ShapesCount { get; }
Property Value
Type |
---|
System.Int32 |
ShapesTotalCount
Declaration
public int ShapesTotalCount { get; }
Property Value
Type |
---|
System.Int32 |
Workbook
Returns parent workbook. Read-only.
Declaration
public WorkbookImpl Workbook { get; }
Property Value
Type |
---|
WorkbookImpl |
Worksheet
Returns parent worksheet. Read-only.
Declaration
public WorksheetImpl Worksheet { get; }
Property Value
Type |
---|
WorksheetImpl |
WorksheetBase
Returns parent WorksheetBase. Read-only.
Declaration
public WorksheetBaseImpl WorksheetBase { get; }
Property Value
Type |
---|
WorksheetBaseImpl |
Methods
AddChildShapes(MsofbtSpContainer, ExcelParseOptions)
Adds new child shape to the collection.
Declaration
protected ShapeImpl AddChildShapes(MsofbtSpContainer shapeContainer, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
MsofbtSpContainer | shapeContainer | Shape container to add. |
ExcelParseOptions | options | Parse options. |
Returns
Type | Description |
---|---|
ShapeImpl | Newly added shape. |
AddCopy(ShapeImpl)
Adds shape copy to the collection.
Declaration
public IShape AddCopy(ShapeImpl sourceShape)
Parameters
Type | Name | Description |
---|---|---|
ShapeImpl | sourceShape | Shape to copy. |
Returns
Type | Description |
---|---|
IShape | Added shape. |
AddCopy(ShapeImpl, Dictionary<String, String>, Dictionary<Int32, Int32>)
Adds shape copy to shapes collection.
Declaration
public IShape AddCopy(ShapeImpl sourceShape, Dictionary<string, string> hashNewNames, Dictionary<int, int> dicFontIndexes)
Parameters
Type | Name | Description |
---|---|---|
ShapeImpl | sourceShape | Shape to copy. |
System.Collections.Generic.Dictionary<System.String, System.String> | hashNewNames | Dictionary with new names of worksheets. |
System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | Dictionary with new font indexes. |
Returns
Type | Description |
---|---|
IShape | Added shape. |
AddCopy(IShape)
Adds shape copy to the collection.
Declaration
public IShape AddCopy(IShape sourceShape)
Parameters
Type | Name | Description |
---|---|---|
IShape | sourceShape | Shape to copy. |
Returns
Type | Description |
---|---|
IShape | Added shape. |
AddCopy(IShape, Dictionary<String, String>, List<Int32>)
Adds shape copy to shapes collection.
Declaration
public IShape AddCopy(IShape sourceShape, Dictionary<string, string> hashNewNames, List<int> arrFontIndexes)
Parameters
Type | Name | Description |
---|---|---|
IShape | sourceShape | Shape to copy. |
System.Collections.Generic.Dictionary<System.String, System.String> | hashNewNames | Dictionary with new names of worksheets. |
System.Collections.Generic.List<System.Int32> | arrFontIndexes | List with new font indexes. |
Returns
Type | Description |
---|---|
IShape | Added shape. |
AddGroupShape(MsofbtSpgrContainer, ExcelParseOptions)
Adds the group container shapes.
Declaration
protected ShapeImpl AddGroupShape(MsofbtSpgrContainer shapes, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
MsofbtSpgrContainer | shapes | Group Shape record to add. |
ExcelParseOptions | options | Parse options. |
Returns
Type | Description |
---|---|
ShapeImpl | Newly added shape. |
AddShape(ShapeImpl)
Adds new shape to the collection.
Declaration
public ShapeImpl AddShape(ShapeImpl newShape)
Parameters
Type | Name | Description |
---|---|---|
ShapeImpl | newShape | Shape to add. |
Returns
Type | Description |
---|---|
ShapeImpl | Newly added shape. |
AddShape(MsoBase, ExcelParseOptions)
Adds new shape to the collection.
Declaration
protected ShapeImpl AddShape(MsoBase shape, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
MsoBase | shape | Shape record to add. |
ExcelParseOptions | options | Parse options. |
Returns
Type | Description |
---|---|
ShapeImpl | Newly added shape. |
AddShape(MsofbtSpContainer, ExcelParseOptions)
Adds new shape to the collection.
Declaration
protected virtual ShapeImpl AddShape(MsofbtSpContainer shapeContainer, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
MsofbtSpContainer | shapeContainer | Shape container to add. |
ExcelParseOptions | options | Parse options. |
Returns
Type | Description |
---|---|
ShapeImpl | Newly added shape. |
Clone(Object)
Creates copy of the collection.
Declaration
public override object Clone(object parent)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | Parent object for the new collection. |
Returns
Type | Description |
---|---|
System.Object | Copy of the collection. |
Overrides
CreateData(Stream, MsofbtDgContainer, List<Int32>, List<List<BiffRecordRaw>>)
Converts array of records with break indexes into bytes sequence.
Declaration
protected virtual void CreateData(Stream stream, MsofbtDgContainer dgContainer, List<int> arrBreaks, List<List<BiffRecordRaw>> arrRecords)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | Stream to put resulting data into. |
MsofbtDgContainer | dgContainer | Container. |
System.Collections.Generic.List<System.Int32> | arrBreaks | List with break indexes. |
System.Collections.Generic.List<System.Collections.Generic.List<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw>> | arrRecords | List with records to serialize. |
CreateGroupShape(MsofbtSpgrContainer, ExcelParseOptions)
Create the group container shapes.
Declaration
protected ShapeImpl CreateGroupShape(MsofbtSpgrContainer shapes, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
MsofbtSpgrContainer | shapes | Group Shape record to create. |
ExcelParseOptions | options | Parse options. |
Returns
Type | Description |
---|---|
ShapeImpl | Newly created shape. |
CreateShape(TObjType, MsofbtSpContainer, ExcelParseOptions, List<ObjSubRecord>, Int32)
Creates new shape object.
Declaration
protected virtual ShapeImpl CreateShape(TObjType objType, MsofbtSpContainer shapeContainer, ExcelParseOptions options, List<ObjSubRecord> subRecords, int cmoIndex)
Parameters
Type | Name | Description |
---|---|---|
TObjType | objType | Object type to create. |
MsofbtSpContainer | shapeContainer | Shape container. |
ExcelParseOptions | options | Parse options. |
System.Collections.Generic.List<ObjSubRecord> | subRecords | Subrecords of the shape's OBJRecord. |
System.Int32 | cmoIndex | Index to the cmo record inside subrecords. |
Returns
Type |
---|
ShapeImpl |
InitializeCollection()
Initializes collection.
Declaration
protected virtual void InitializeCollection()
ParseMsoStructures(List<MsoBase>, ExcelParseOptions)
Parses MsoDrawing records.
Declaration
public void ParseMsoStructures(List<MsoBase> arrStructures, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<MsoBase> | arrStructures | Array of MsoDrawing records. |
ExcelParseOptions | options | Parse options. |
RegisterInWorksheet()
Registers in the parent worksheet.
Declaration
protected virtual void RegisterInWorksheet()
Remove(IShape)
Removes shape from the collection.
Declaration
public void Remove(IShape shape)
Parameters
Type | Name | Description |
---|---|---|
IShape | shape | Shape to remove. |
Serialize(OffsetArrayList)
Serializes shapes collection.
Declaration
public void Serialize(OffsetArrayList records)
Parameters
Type | Name | Description |
---|---|---|
OffsetArrayList | records | Array of records that will receive all shapes. |
SetParents()
Searches for all necessary parent objects.
Declaration
protected void SetParents()