IXpsSignatureRequest::SetSpotLocation method

Specifies the page and the location on the page where the visible digital signature or the digital signature request will be displayed.

Syntax

HRESULT SetSpotLocation(
  [in] INT32 pageIndex,
  [in] float x,
  [in] float y
);

Parameters

  • pageIndex [in]
    The index value of the FixedPage part in the XPS document that contains the visible digital signature or the digital signature request.

    If the value of this parameter is –1, a SpotLocation element will not be written to the SignatureDefinitions markup.

    If the value of this parameter is not –1, it must be a page number that exists in the FixedDocument part to which the signature block that contains this request is attached.

  • x [in]
    The x-coordinate value of the signing spot on the page.

  • y [in]
    The y-coordinate value of the signing spot on the page.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For return values that are not listed in this table, see XPS Digital Signature API Errors and XPS Document Errors.

Return code Description
S_OK

The method succeeded.

E_UNEXPECTED

The interface is not connected to the signature manager.

 

Remarks

The location of the signing spot is specified in XPS units from the upper-left corner of the page. There are 96 XPS units per inch.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Xpsdigitalsignature.h

IDL

XpsDigitalSignature.idl

See also

IXpsSignatureRequest

IXpsSignatureBlock

IXpsSignatureManager

XPS Digital Signature API Errors

XPS Document Errors

XML Paper Specification