Show 

Home > eRoom API Help > Server Access API > SAAPI Methods > SetStationeryPosition method

Show Show 

 

SetStationeryPosition method

Move the Stationery to another position on the Folder Page.

Syntax

C++
HRESULT SetStationeryPosition(
   IERUStationery* pStationery
   LONG Index)
Scripting languages
Object.SetStationeryPosition
   Stationery as IERUStationery,
   Index as Long

Parameters

pStationery

The Stationery object to reposition.

Index

The new index to give the stationery.

Return value

C++

The return code.
Scripting languages

None.

Remarks

The index starts from 1. The Index is the new position for the stationery being moved. When the stationery is moved, the remaining stationery objects are re-indexed in order to fill in the gap left by the moved stationery.

  • If the stationery is moved to a higher index, then all stationery objects between the moved stationery and the gap will have their indices decremented by one.

  • If the stationery is moved to a lower index, then all stationery objects between the moved stationery and the gap will have their indices incremented by one.

Home

Interface
IERUStationeryManager

See also
IERUStationery