Class BitmapShapeImpl
Class used for Bitmap shape implementation.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Shapes
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class BitmapShapeImpl : ShapeImpl, ICloneParent, INamedObject, IDisposable, IPictureShape, IShape, IParentApplication
Constructors
BitmapShapeImpl(IApplication, Object)
Initializes a new instance of the BitmapShapeImpl class.
Declaration
public BitmapShapeImpl(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Current application. |
System.Object | parent | Parent object |
BitmapShapeImpl(IApplication, Object, MsoBase[], Int32)
Initializes a new instance of the BitmapShapeImpl class.
Declaration
public BitmapShapeImpl(IApplication application, object parent, MsoBase[] records, int index)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Current application. |
System.Object | parent | Parent object. |
MsoBase[] | records | Represents array of records. |
System.Int32 | index | Represent index. |
BitmapShapeImpl(IApplication, Object, MsofbtSpContainer)
Initializes a new instance of the BitmapShapeImpl class.
Declaration
public BitmapShapeImpl(IApplication application, object parent, MsofbtSpContainer container)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Current application. |
System.Object | parent | Parent object. |
MsofbtSpContainer | container | Represents container. |
BitmapShapeImpl(IApplication, Object, Boolean)
Initializes a new instance of the BitmapShapeImpl class.
Declaration
public BitmapShapeImpl(IApplication application, object parent, bool IncludeShapeOptions)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Current application. |
System.Object | parent | Parent object. |
System.Boolean | IncludeShapeOptions | Indicates is shape include options. False supports only for header / footer image. |
Fields
cropOptions
CropOptions of BitmapShape
Declaration
protected MsoOptions[] cropOptions
Field Value
Type |
---|
MsoOptions[] |
ShapeInstance
Instance field value for this shape.
Declaration
public const int ShapeInstance = 75
Field Value
Type |
---|
System.Int32 |
Properties
BlipId
Gets or sets Blip id.
Declaration
public uint BlipId { get; set; }
Property Value
Type |
---|
System.UInt32 |
BlipSubNodesStream
Gets or sets stream that contains subnodes of the blip xml node in Excel 2007 format.
Declaration
public Stream BlipSubNodesStream { get; set; }
Property Value
Type |
---|
System.IO.Stream |
FileName
Gets or sets Blip file name
Declaration
public string FileName { get; set; }
Property Value
Type |
---|
System.String |
HasTransparency
Used for internal purpose.
Declaration
public bool HasTransparency { get; set; }
Property Value
Type |
---|
System.Boolean |
Hyperlink
Get object that represents the hyperlink for the shape.
Declaration
public IHyperLink Hyperlink { get; }
Property Value
Type |
---|
IHyperLink |
Instance
Returns instance value. Read-only.
Declaration
public override int Instance { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
IsCamera
Gets or sets if the BitmapShape is Camera
Declaration
public bool IsCamera { get; set; }
Property Value
Type |
---|
System.Boolean |
IsDDE
Gets or sets if the BitmapShape is DDE
Declaration
public bool IsDDE { get; set; }
Property Value
Type |
---|
System.Boolean |
Macro
Gets or sets macro name associated with this shape.
Declaration
public string Macro { get; set; }
Property Value
Type |
---|
System.String |
Picture
Gets or sets picture.
Declaration
public Image Picture { get; set; }
Property Value
Type |
---|
Image |
ShapePropertiesStream
Gets or sets Stream that contains shape properties xml-tag in Excel 2007 format. Obsolete, will be removed in future release.
Declaration
public Stream ShapePropertiesStream { get; set; }
Property Value
Type |
---|
System.IO.Stream |
SourceRectStream
Gets or sets stream that contains srcRect tag if shape was extracted from Excel 2007 file.
Declaration
public Stream SourceRectStream { get; set; }
Property Value
Type |
---|
System.IO.Stream |
SvgData
Gets or sets Svg data for the picture.
Declaration
public Stream SvgData { get; set; }
Property Value
Type |
---|
System.IO.Stream |
Methods
Clone(Object, Dictionary<String, String>, Dictionary<Int32, Int32>, Boolean)
Creates a clone of the current shape.
Declaration
public override IShape Clone(object parent, Dictionary<string, string> hashNewNames, Dictionary<int, int> dicFontIndexes, bool addToCollection)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | New parent for the shape object. |
System.Collections.Generic.Dictionary<System.String, System.String> | hashNewNames | Dictionary with new worksheet names. |
System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | Dictionary with new font indexes. |
System.Boolean | addToCollection | Indicates whether we should add created shape into all necessary parent collections. This argument is ignored. |
Returns
Type | Description |
---|---|
IShape | A copy of the current shape. |
Overrides
Dispose()
Dispose object.
Declaration
public void Dispose()
ExtractNecessaryOption(MsofbtOPT.FOPTE)
Extract necessary option.
Declaration
protected override bool ExtractNecessaryOption(MsofbtOPT.FOPTE option)
Parameters
Type | Name | Description |
---|---|---|
MsofbtOPT.FOPTE | option | Option to extract. |
Returns
Type | Description |
---|---|
System.Boolean | value indicating extracted option. |
Overrides
GenerateDefaultName()
Generates default shape name and sets it.
Declaration
public override void GenerateDefaultName()
Overrides
OnDelete()
This method is called when shapes is deleted.
Declaration
protected override void OnDelete()
Overrides
OnDelete(Boolean)
This method is called when shapes is deleted.
Declaration
protected void OnDelete(bool removeImage)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | removeImage | Removes image that is referenced by this shape from collection too, if we didn't detect image usage. XlsIO doesn't detect this situation correctly in all cases if there are shapes in charts in Excel 2007 or if some image shapes are grouped in any excel version. If you are not sure whether image is referenced in charts or grouped shapes and you are working with Excel 2007 version, set this argument to true (this could cause file size increase, but will keep document in the correct state). |
OnPrepareForSerialization()
This method is called inside of PrepareForSerialization to make shape-dependent preparations.
Declaration
protected override void OnPrepareForSerialization()
Overrides
ParseBlipId(MsofbtOPT.FOPTE)
Parses blip id option.
Declaration
protected virtual void ParseBlipId(MsofbtOPT.FOPTE option)
Parameters
Type | Name | Description |
---|---|---|
MsofbtOPT.FOPTE | option | Option to parse. |
ParseBlipName(MsofbtOPT.FOPTE)
Parses blip name option.
Declaration
protected virtual void ParseBlipName(MsofbtOPT.FOPTE option)
Parameters
Type | Name | Description |
---|---|---|
MsofbtOPT.FOPTE | option | Option to parse. |
ParseCropRectangle(MsofbtOPT.FOPTE)
Parse the Crop Rectangle
Declaration
protected void ParseCropRectangle(MsofbtOPT.FOPTE option)
Parameters
Type | Name | Description |
---|---|---|
MsofbtOPT.FOPTE | option |
ParseOption(MsofbtOPT.FOPTE)
Checks Blip parse option.
Declaration
protected override bool ParseOption(MsofbtOPT.FOPTE option)
Parameters
Type | Name | Description |
---|---|---|
MsofbtOPT.FOPTE | option | Represents option. |
Returns
Type | Description |
---|---|
System.Boolean | Value indicating parse option. |
Overrides
RegisterInSubCollection()
Registers shape in all required sub collections.
Declaration
public override void RegisterInSubCollection()
Overrides
Remove(Boolean)
Removes shape from the collection.
Declaration
public void Remove(bool removeImage)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | removeImage | Removes image that is referenced by this shape from collection too, if we didn't detect image usage. XlsIO doesn't detect this situation correctly in all cases if there are shapes in charts in Excel 2007 or if some image shapes are grouped in any excel version. If you are not sure whether image is referenced in charts or grouped shapes and you are working with Excel 2007 version, set this argument to true (this could cause file size increase, but will keep document in the correct state). |
SerializeShape(MsofbtSpgrContainer)
Serializes shape.
Declaration
protected override void SerializeShape(MsofbtSpgrContainer spgrContainer)
Parameters
Type | Name | Description |
---|---|---|
MsofbtSpgrContainer | spgrContainer | Represents Spgr container |
Overrides
SetBlipId(UInt32)
Sets Blip id.
Declaration
public void SetBlipId(uint newId)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | newId | new Blip id |
UpdateMso(MsoBase)
Updates mso object.
Declaration
protected override bool UpdateMso(MsoBase mso)
Parameters
Type | Name | Description |
---|---|---|
MsoBase | mso | Represents mso object to update. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true if updated otherwise - false. |