VintaSoft Twain .NET SDK v10.2
GetAsString Method (DeviceImageLayout)




Vintasoft.WpfTwain Namespace > DeviceImageLayout Class : GetAsString Method
Gets the current image layout rectangle of document/page/frame.
Syntax
'Declaration
 
Public Function GetAsString() As String
'Usage
 
Dim instance As DeviceImageLayout
Dim value As String
 
value = instance.GetAsString()
public string GetAsString()
public: string* GetAsString(); 
public:
String^ GetAsString(); 

Return Value

Coordinate values of the image layout rectangle as a string in the following format: "left top right bottom". Here is an example: "0.0 0.33 3.47 6.12".
Exceptions
ExceptionDescription
Thrown if the .NET debugger is used and the function evaluation requires all threads to run.
Remarks
The image layout rectangle defines what portion of the device's scanning area will be acquired.

Document number can be set using the DocumentNumber property, Page number can be set using the PageNumber property, Frame number can be set using the FrameNumber property

Call this method only when device is opened (State == DeviceState.Opened).

This method has effect only if you do not use the User Interface (ShowUI=false).
Example
Please see example here.
Requirements

Target Platforms: Windows 8, Windows 7, Windows Vista, Windows XP, Windows Server 2012, Windows Server 2008, Windows Server 2003

See Also

Reference

DeviceImageLayout Class
DeviceImageLayout Members
Open Method
Set(String) Method