Class PictureCollection

Namespace: Aspose.Cells.Drawing
Assembly: Aspose.Cells.dll (25.2.0)

Encapsulates a collection of Aspose.Cells.Drawing.Picture objects.

public class PictureCollection : CollectionBase<picture>, IList<picture>, ICollection<picture>, IEnumerable<picture>, ICollection, IEnumerable

Inheritance

object ← CollectionBase<picture> ← PictureCollection

Implements

IList<picture>, ICollection<picture>, IEnumerable<picture>, ICollection, IEnumerable

Inherited Members

CollectionBase<picture>.BinarySearch(Picture), CollectionBase<picture>.BinarySearch(Picture, IComparer<picture>), CollectionBase<picture>.BinarySearch(int, int, Picture, IComparer<picture>), CollectionBase<picture>.Contains(Picture), CollectionBase<picture>.CopyTo(Picture[]), CollectionBase<picture>.CopyTo(Picture[], int), CollectionBase<picture>.CopyTo(int, Picture[], int, int), CollectionBase<picture>.Exists(Predicate<picture>), CollectionBase<picture>.Find(Predicate<picture>), CollectionBase<picture>.FindAll(Predicate<picture>), CollectionBase<picture>.FindIndex(Predicate<picture>), CollectionBase<picture>.FindIndex(int, Predicate<picture>), CollectionBase<picture>.FindIndex(int, int, Predicate<picture>), CollectionBase<picture>.FindLast(Predicate<picture>), CollectionBase<picture>.FindLastIndex(Predicate<picture>), CollectionBase<picture>.FindLastIndex(int, Predicate<picture>), CollectionBase<picture>.FindLastIndex(int, int, Predicate<picture>), CollectionBase<picture>.IndexOf(Picture), CollectionBase<picture>.IndexOf(Picture, int), CollectionBase<picture>.IndexOf(Picture, int, int), CollectionBase<picture>.LastIndexOf(Picture), CollectionBase<picture>.LastIndexOf(Picture, int), CollectionBase<picture>.LastIndexOf(Picture, int, int), CollectionBase<picture>.GetEnumerator(), CollectionBase<picture>.Clear(), CollectionBase<picture>.RemoveAt(int), CollectionBase<picture>.OnClearComplete(), CollectionBase<picture>.OnClear(), CollectionBase<picture>.Capacity, CollectionBase<picture>.Count, CollectionBase<picture>.InnerList, CollectionBase<picture>.this[int], object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Examples

csharp
[C#]

//Instantiating a Workbook object
Workbook workbook = new Workbook();

//get PictureCollection
PictureCollection pictures = workbook.Worksheets[0].Pictures;

//do your business

//Save the excel file.
workbook.Save("result.xlsx");

Properties

this[int]

Gets the Aspose.Cells.Drawing.Picture element at the specified index.

public Picture this[int index] { get; }

Property Value

Picture

Examples

csharp
[C#]
//get picture collection
//PictureCollection pictures = workbook.Worksheets[0].Pictures;
//add a picture
int index = pictures.Add(1, 1, "image.png");
//get the picture
Picture pic = pictures[index];

Methods

Add(int, int, int, int, Stream)

Adds a picture to the collection.

public int Add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, Stream stream)

Parameters

upperLeftRow int

Upper left row index.

upperLeftColumn int

Upper left column index.

lowerRightRow int

Lower right row index

lowerRightColumn int

Lower right column index

stream Stream

Stream object which contains the image data.

Returns

int

Aspose.Cells.Drawing.Picture object index.

Examples

csharp
[C#]
//add a picture
using (FileStream fs = new FileStream("image.jpg", FileMode.Open))
{
    pictures.Add(1, 1, 5, 5, fs);
}

Add(int, int, int, int, string)

Adds a picture to the collection.

public int Add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, string fileName)

Parameters

upperLeftRow int

Upper left row index.

upperLeftColumn int

Upper left column index.

lowerRightRow int

Lower right row index

lowerRightColumn int

Lower right column index

fileName string

Image filename.

Returns

int

Aspose.Cells.Drawing.Picture object index.

Examples

csharp
[C#]
//add a picture
pictures.Add(1, 1, 5, 5, "image.jpg");

Add(int, int, Stream)

Adds a picture to the collection.

public int Add(int upperLeftRow, int upperLeftColumn, Stream stream)

Parameters

upperLeftRow int

Upper left row index.

upperLeftColumn int

Upper left column index.

stream Stream

Stream object which contains the image data.

Returns

int

Aspose.Cells.Drawing.Picture object index.

Examples

csharp
[C#]
//add a picture
using (FileStream fs = new FileStream("image.jpg", FileMode.Open))
{
    pictures.Add(1, 1, fs);
}

Add(int, int, string)

Adds a picture to the collection.

public int Add(int upperLeftRow, int upperLeftColumn, string fileName)

Parameters

upperLeftRow int

Upper left row index.

upperLeftColumn int

Upper left column index.

fileName string

Image filename.

Returns

int

Aspose.Cells.Drawing.Picture object index.

Examples

csharp
[C#]
//add a picture
pictures.Add(1, 1, "image.jpg");

Add(int, int, Stream, int, int)

Adds a picture to the collection.

public int Add(int upperLeftRow, int upperLeftColumn, Stream stream, int widthScale, int heightScale)

Parameters

upperLeftRow int

Upper left row index.

upperLeftColumn int

Upper left column index.

stream Stream

Stream object which contains the image data.

widthScale int

Scale of image width, a percentage.

heightScale int

Scale of image height, a percentage.

Returns

int

Aspose.Cells.Drawing.Picture object index.

Examples

csharp
[C#]
//add a picture
using (FileStream fs = new FileStream("image.jpg", FileMode.Open))
{
    pictures.Add(1, 1, fs, 50, 50);
}

Add(int, int, string, int, int)

Adds a picture to the collection.

public int Add(int upperLeftRow, int upperLeftColumn, string fileName, int widthScale, int heightScale)

Parameters

upperLeftRow int

Upper left row index.

upperLeftColumn int

Upper left column index.

fileName string

Image filename.

widthScale int

Scale of image width, a percentage.

heightScale int

Scale of image height, a percentage.

Returns

int

Aspose.Cells.Drawing.Picture object index.

Examples

csharp
[C#]
//add a picture
pictures.Add(1, 1, "image.jpg", 50, 50);

Clear()

Clear all pictures.

public void Clear()

Examples

csharp
[C#]
//clear
pictures.Clear();

RemoveAt(int)

Remove shapes at the specific index

public void RemoveAt(int index)

Parameters

index int

Examples

csharp
[C#]
//add a picture
int index2 = pictures.Add(1, 1, "image.png");
//delete
pictures.RemoveAt(index2);

</picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture></picture>