Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

ImageIterator Class

Allows you to iterate over an image collection.

#Declaration

TypeScript
export class ImageIterator

#Remarks

The example below demonstrates how to change the wrapping type of every document image to Inline.

var imgIterator = richEdit.document.images.getIterator();
while(imgIterator.next())
  imgIterator.image.changeWrapType(DevExpress.RichEdit.WrapType.Inline);

#Properties

#image Property

Returns an image that is marked as the current image in the iterator.

#Declaration

TypeScript
get image(): InlineImage | FloatingImage | null

#Property Value

Type Description
FloatingImage

An object that contains settings of the current image (if the current image is a floating image). null if the iterator has no current image.

InlineImage

An object that contains settings of the current image (if the current image is an inline image). null if the iterator has no current image.

#Remarks

The image property returns the null value in the following cases:

  • The iterator has just been created. Call the next method to start image traversal.
  • The iterator has traversed through all images.

#Methods

#next Method

Sets the next image in the collection as the current image.

#Declaration

TypeScript
next(): boolean

#Returns

Type Description
boolean

true, if the next image exists; otherwise, false.