ScanRegionYOffset element

Article
05/02/2023

The optional ScanRegionYOffset element specifies the distance from the slow scan lead edge to the beginning of the scan region.

Usage

<wscn:ScanRegionYOffset wscn:MustHonor="" wscn:Override="" wscn:UsedDefault=""
  MustHonor = "xs:string"
  Override = "xs:string"
  UsedDefault = "xs:string">
  text
</wscn:ScanRegionYOffset wscn:MustHonor="" wscn:Override="" wscn:UsedDefault="">

Attributes

Attribute	Type	Required	Description
MustHonor	xs:string	No	Optional. A Boolean value that must be 0, false, 1, or true.falsetrue
Override	xs:string	No	Optional. A Boolean value that must be 0, false, 1, or true.falsetrue
UsedDefault	xs:string	No	Optional. A Boolean value that must be 0, false, 1, or true.falsetrue

Text value

Required. An integer between 0 and the InputMediaSize height.InputMediaSize

Child elements

There are no child elements.

Parent elements

Element
ScanRegion

Remarks

For more information about the scan region parameters, see ScanRegion.

The client can specify the optional MustHonor attribute only when the ScanRegionYOffset element is contained within a CreateScanJobRequest hierarchy. For more information about MustHonor and its usage, see CreateScanJobRequest.

The WSD Scan Service can specify the optional Override and UsedDefault attributes only when the ScanRegionYOffset element is contained within a DocumentFinalParameters hierarchy. For more information about Override and UsedDefault and their usage, see DocumentFinalParameters.