SetLayout(String) Method (DeviceImageLayout)

In This Topic

Sets the image layout rectangle of document/page/frame.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Public Sub SetLayout( _
   ByVal frameCoordinate values the image layout rectangle in the following format: "left top right bottom".
 As String _
)

public void SetLayout(
   string frame
)

public: void SetLayout(
   string* frame
)

public:
void SetLayout(
   string^ frame
)

Parameters

frame: Coordinate values the image layout rectangle in the following format: "left top right bottom".

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if frame is null.
System.FormatException	Thrown if frame contains numbers in not a valid format.
System.OverflowException	Thrown if frame contains number less than System.Single.MinValue or greater than System.Single.MaxValue.
DebuggerException	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).

This method should be used in programming environments which cannot work with referred float value, for example, in JavaScript.

Example

Please see example here: DeviceImageLayout.

Requirements

Target Platforms: .NET 8, .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

DeviceImageLayout Class
DeviceImageLayout Members

Open
GetAsString
Set(String)

Send Feedback