Aspose API References – XImageCollection

Net: Count

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.Count property

Count of images in collection.

public int Count { get; }

Net: IsReadOnly

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.IsReadOnly property

Gets a value indicating whether the collection is read-only.

public bool IsReadOnly { get; }

Net: IsSynchronized

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.IsSynchronized property

Returns true if object is synchronized.

public bool IsSynchronized { get; }

Net: Item

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection indexer (1 of 2)

Gets image from collection by its index.

public XImage this[int index] { get; }

Parameter	Description
index	Image index

Return Value

Retrieved image.

XImageCollection indexer (2 of 2)

Gets image from collection by its name.

public XImage this[string name] { get; }

Parameter	Description
name	Image name.

Return Value

Retrieved image.

Net: Names

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.Names property

Gets array of image names.

public string[] Names { get; }

Net: SyncRoot

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.SyncRoot property

Returns synchronization object.

public object SyncRoot { get; }

Net: Add

Mon, 01 Jan 0001 00:00:00 +0000

Add(XImage)

Adds new image to Image list. This method adds image as reference to the same PdfObject (which allows to decrease file size)

public string Add(XImage image)

Parameter	Type	Description
image	XImage	XImage to be added.

Return Value

Name of the added image.

Add(Stream)

Adds entity to the end of the collection, so entity can be accessed by the last index.

public string Add(Stream image)

Parameter	Type	Description
image	Stream	Stream containing image data (in JPEG format).

Return Value

Name of the added image.

Add(Stream, ImageFilterType)

Adds entity to the end of the collection, so entity can be accessed by the last index.

public string Add(Stream image, ImageFilterType filterType)

Parameter	Type	Description
image	Stream	Stream containing image data.
filterType	ImageFilterType	The image filter type.

Return Value

Name of the added image.

Add(Stream, int)

Adds entity to the end of the collection, so entity can be accessed by the last index.

public void Add(Stream image, int quality)

Parameter	Type	Description
image	Stream	Stream containing image data (in JPEG format).
quality	Int32	JPEG quality.

Net: Clear

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.Clear method

Clears all items from the collection.

public void Clear()

Net: Contains

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.Contains method

Determines whether the collection contains a specific value.

public bool Contains(XImage item)

Parameter	Type	Description
item	XImage	The object to locate in the collection.

Return Value

true if item is found in the collection; otherwise, false.

Net: CopyTo

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.CopyTo method

Copies array of images into collection.

public void CopyTo(XImage[] array, int index)

Parameter	Type	Description
array	XImage[]	Array to be copied.
index	Int32	Index where images will be copied into collection.

Net: Delete

Mon, 01 Jan 0001 00:00:00 +0000

Delete(int)

Removes index from collection by index.

public void Delete(int index)

Parameter	Type	Description
index	Int32	Image index.

Delete(int, ImageDeleteAction)

Removes image from collection by index performing action specified by action parameter.

public void Delete(int index, ImageDeleteAction action)

Parameter	Type	Description
index	Int32	Index of the image to be removed.
action	ImageDeleteAction	Action perfromed after image deleting.

Delete(string)

Removes item from collection by name.

public void Delete(string name)

Parameter	Type	Description
name	String	Name of image which must to be deleted.

Delete(string, ImageDeleteAction)

Removes item from collection by name.

public void Delete(string name, ImageDeleteAction action)

Parameter	Type	Description
name	String	Name of image which must to be deleted.
action	ImageDeleteAction	Action to be performed with image object.

Delete()

Deletes images from collection.

public void Delete()

Net: GetEnumerator

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.GetEnumerator method

Returns collection enumerator.

public IEnumerator<XImage> GetEnumerator()

Return Value

Enumerator of collection

Net: GetImageName

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.GetImageName method

Returns name in images list which is key of the given image.

public string GetImageName(XImage image)

Parameter	Type	Description
image	XImage	Image to search.

Return Value

Name (key) of the found image; null if images was not found.

Net: Remove

Mon, 01 Jan 0001 00:00:00 +0000

XImageCollection.Remove method

Removes item from collection, throws NotImplementedException.

public bool Remove(XImage item)

Parameter	Type	Description
item	XImage	Item to remove.

Return Value

NotImplementedException

Net: Replace

Mon, 01 Jan 0001 00:00:00 +0000

Replace(int, Stream)

Replace image in collection with another image.

public void Replace(int index, Stream stream)

Parameter	Type	Description
index	Int32	Index of collection item which will be replaced.
stream	Stream	Stream containing image data (in JPEG format).

Replace(int, Stream, int, bool)

Replace image in collection with another image.

public void Replace(int index, Stream stream, int quality, bool isBlackAndWhite)

Parameter	Type	Description
index	Int32	Index of collection item which will be replaced.
stream	Stream	Stream containing image data (in JPEG format).
quality	Int32	Quality of JPEG compression, in percent (valid vaues are 0..100).
isBlackAndWhite	Boolean	If true, image is compressed with CCITT compression method which provides better compression for black nad white image. May be used only for black and white images.

Replace(int, Stream, int)

Replace image in collection with another image.

public void Replace(int index, Stream stream, int quality)

Parameter	Type	Description
index	Int32	Index of collection item which will be replaced.
stream	Stream	Stream containing image data (in JPEG format).
quality	Int32	JPEG quality.

Aspose API References – XImageCollection

Net: Count

XImageCollection.Count property

See Also

Net: IsReadOnly

XImageCollection.IsReadOnly property

See Also

Net: IsSynchronized

XImageCollection.IsSynchronized property

See Also

Net: Item

XImageCollection indexer (1 of 2)

Return Value

See Also

XImageCollection indexer (2 of 2)

Return Value

See Also

Net: Names

XImageCollection.Names property

See Also

Net: SyncRoot

XImageCollection.SyncRoot property

See Also

Net: Add

Add(XImage)

Return Value

See Also

Add(Stream)

Return Value

See Also

Add(Stream, ImageFilterType)

Return Value

See Also

Add(Stream, int)

See Also

Net: Clear

XImageCollection.Clear method

See Also

Net: Contains

XImageCollection.Contains method

Return Value

See Also

Net: CopyTo

XImageCollection.CopyTo method

See Also

Net: Delete

Delete(int)

See Also

Delete(int, ImageDeleteAction)

See Also

Delete(string)

See Also

Delete(string, ImageDeleteAction)

See Also

Delete()

See Also

Net: GetEnumerator

XImageCollection.GetEnumerator method

Return Value

See Also

Net: GetImageName

XImageCollection.GetImageName method

Return Value

See Also

Net: Remove

XImageCollection.Remove method

Return Value

See Also

Net: Replace

Replace(int, Stream)

See Also

Replace(int, Stream, int, bool)

See Also

Replace(int, Stream, int)

See Also