Class PicturesCollection
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
public class PicturesCollection : CollectionBaseEx<IPictureShape>, IList<IPictureShape>, ICollection<IPictureShape>, IEnumerable<IPictureShape>, ICloneParent, IPictures, IParentApplication, IEnumerable
Constructors
PicturesCollection(IApplication, Object)
Declaration
public PicturesCollection(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | |
System.Object | parent |
Properties
Item[String]
Gets single item from the collection.
Declaration
public IPictureShape this[string name] { get; }
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the item to get. |
Property Value
Type | Description |
---|---|
IPictureShape | Single item from the collection. |
Methods
AddPicture(Image, String)
Adds picture to the collection.
Declaration
public IPictureShape AddPicture(Image image, string pictureName)
Parameters
Type | Name | Description |
---|---|---|
Image | image | Picture to add. |
System.String | pictureName | Picture name. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Image, String, ExcelImageFormat)
Adds picture to the collection.
Declaration
public IPictureShape AddPicture(Image image, string pictureName, ExcelImageFormat imageFormat)
Parameters
Type | Name | Description |
---|---|---|
Image | image | Picture to add. |
System.String | pictureName | Picture name. |
ExcelImageFormat | imageFormat | Image format to use for picture storing. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Image)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Image image)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
Image | image | Image. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Image, ExcelImageFormat)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Image image, ExcelImageFormat imageFormat)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
Image | image | Image to add. |
ExcelImageFormat | imageFormat | Image format to use for picture storing. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Image, Int32, Int32)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Image image, int scaleWidth, int scaleHeight)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
Image | image | Image. |
System.Int32 | scaleWidth | Width scale in percents. |
System.Int32 | scaleHeight | Height scale in percents. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Image, Int32, Int32, ExcelImageFormat)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Image image, int scaleWidth, int scaleHeight, ExcelImageFormat imageFormat)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
Image | image | Image. |
System.Int32 | scaleWidth | Width scale in percents. |
System.Int32 | scaleHeight | Height scale in percents. |
ExcelImageFormat | imageFormat | Image format to use for picture storing. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Int32, Int32, Image)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, int bottomRow, int rightColumn, Image image)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.Int32 | bottomRow | Bottom row. |
System.Int32 | rightColumn | Right column. |
Image | image | Image. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Int32, Int32, Image, ExcelImageFormat)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, int bottomRow, int rightColumn, Image image, ExcelImageFormat imageFormat)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.Int32 | bottomRow | Bottom row. |
System.Int32 | rightColumn | Right column. |
Image | image | Image to add. |
ExcelImageFormat | imageFormat | Image format to use for picture storing. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Int32, Int32, Stream)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, int bottomRow, int rightColumn, Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.Int32 | bottomRow | Bottom row. |
System.Int32 | rightColumn | Right column. |
System.IO.Stream | stream | Stream with the picture. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Int32, Int32, Stream, ExcelImageFormat)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, int bottomRow, int rightColumn, Stream stream, ExcelImageFormat imageFormat)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.Int32 | bottomRow | Bottom row. |
System.Int32 | rightColumn | Right column. |
System.IO.Stream | stream | Stream with the picture. |
ExcelImageFormat | imageFormat | Image format to use for picture storing. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Stream)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.IO.Stream | stream | Stream with the picture. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Stream, ExcelImageFormat)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Stream stream, ExcelImageFormat imageFormat)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.IO.Stream | stream | Stream with the picture. |
ExcelImageFormat | imageFormat | Image format to use for picture storing. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Stream, Int32, Int32)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Stream stream, int scaleWidth, int scaleHeight)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.IO.Stream | stream | Stream with the picture. |
System.Int32 | scaleWidth | Width scale in percents. |
System.Int32 | scaleHeight | Height scale in percents. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Stream, Int32, Int32, ExcelImageFormat)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Stream stream, int scaleWidth, int scaleHeight, ExcelImageFormat imageFormat)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.IO.Stream | stream | Stream with the picture. |
System.Int32 | scaleWidth | Width scale in percents. |
System.Int32 | scaleHeight | Height scale in percents. |
ExcelImageFormat | imageFormat | Image format to use for picture storing. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Stream, Stream)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Stream svgStream, Stream imageStream)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.IO.Stream | svgStream | |
System.IO.Stream | imageStream | The System.IO.Stream instance of fallback image. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPicture(Int32, Int32, Stream, Stream, Int32, Int32)
Adds image to the collection.
Declaration
public IPictureShape AddPicture(int topRow, int leftColumn, Stream svgStream, Stream imageStream, int scaleWidth, int scaleHeight)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of a new picture. |
System.Int32 | leftColumn | Left column. |
System.IO.Stream | svgStream | Svg stream with the picture. |
System.IO.Stream | imageStream | The System.IO.Stream instance of fallback image. |
System.Int32 | scaleWidth | Width scale in percents. |
System.Int32 | scaleHeight | Height scale in percents. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |
AddPictureAsLink(Int32, Int32, Int32, Int32, String)
Adds image from the given external link.
Declaration
public IPictureShape AddPictureAsLink(int topRow, int leftColumn, int bottomRow, int rightColumn, string url)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | topRow | Top row of the picture to start with. |
System.Int32 | leftColumn | Left column of the picture to start with. |
System.Int32 | bottomRow | Bottom row of the picture to end with. |
System.Int32 | rightColumn | Right column of the picture to end with. |
System.String | url | Url of the picture. |
Returns
Type | Description |
---|---|
IPictureShape | Added picture. |