ImageIterator Class
Allows you to iterate over an image collection.
#Declaration
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
get image(): InlineImage | FloatingImage | null
#Property Value
Type | Description |
---|---|
Floating |
An object that contains settings of the current image (if the current image is a floating image). |
Inline |
An object that contains settings of the current image (if the current image is an inline 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
next(): boolean
#Returns
Type | Description |
---|---|
boolean | true, if the next image exists; otherwise, false. |