Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
SourceImage Property
See Also 
Leadtools.ImageProcessing Namespace > CloneCommand Class : SourceImage Property



Gets the source image used in this CloneCommand

Syntax

Visual Basic (Declaration)  
Public ReadOnly Property SourceImage As RasterImage
Visual Basic (Usage) Copy Code
Dim instance As CloneCommand
Dim value As RasterImage
 
value = instance.SourceImage
C#  
public RasterImage SourceImage {get;}
C++/CLI  
public:
property RasterImage^ SourceImage {
   RasterImage^ get();
}

Return Value

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

Example

For an example, refer to AllPages.

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.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also