SourceImage Property

Summary

Gets the source image used in this CloneCommand

Syntax

Objective-C

C++

Java

public RasterImage SourceImage { get; }

Public ReadOnly Property SourceImage As RasterImage

@property (nonatomic, strong, readonly, nullable) LTRasterImage *sourceImage

public RasterImage getSourceImage()

public: 
property RasterImage^ SourceImage { 
   RasterImage^ get(); 
}

Property Value

A RasterImage object that references the source image used in this command (the image passed to the RasterCommand.Run method).

Remarks

If the source image (the image passed to the RasterCommand.Run method) contains multiple pages, then you can use the AllPages property to control whether the CloneCommand will create a copy of the current active page or all the pages in the image.

Note that when the source image has multiple pages and the value of AllPages was set to true, then the RasterCommand.Progress event will fire from 0 to 100 for each page processed. If an overall progress percentage is desired, then you can inspect the RasterImage.Page and RasterImage.PageCount properties of the SourceImage property to calculate this value as shown in the AllPages example.

The default value of this property is false.

Example

For an example, refer to AllPages.

Requirements

Target Platforms