SetTabSheetDisplayPaper: Operation

bool SetTabSheetDisplayPaper(TabSheetId tTabSheet, TabSheetDisplayPaperArg tArg)

Parameters

Description

Comments

To execute the operation, in the tTabSheet field specify sheet moniker and in the tArg field specify setting value to be set. The moniker can be based on the moniker of opened object instance, with which the work is executed.

The operation results in the logical True if the setting value was changed successfully.

Example

Below is the example of changing page border display setting. The request contains moniker for the sheet that is divided into pages and the settings value to be set. The response contains whether the setting is changed successfully.

SOAP JSON C#

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<id>JONPGPOBGHLNFOAEKLBMKJOPCDGDDHPEFJNDMKCLCALFLGLI!M!S!PNCJKHHPBGHLNFOAECCLLPOGCOBIIAJFEAIMHNHBJIBCIKHKO!Sheets!1</id>

</tTabSheet>

</tArg>

</SetTabSheetDisplayPaper>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "SetTabSheetDisplayPaper" : 
  {
   "tTabSheet" : 
    {
     "id" : "JONPGPOBGHLNFOAEKLBMKJOPCDGDDHPEFJNDMKCLCALFLGLI!M!S!PNCJKHHPBGHLNFOAECCLLPOGCOBIIAJFEAIMHNHBJIBCIKHKO!Sheets!1"
    },
   "tArg" : 
    {
     "dp" : "true"
    }
  }
}

JSON response:

{
 "SetTabSheetDisplayPaperResult" : "1"
}

public static bool SetTabSheetDisplayPaper(string moniker, string sheetKey, bool DisplayPaperOut)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new SetTabSheetDisplayPaper()
    {
        tArg = new TabSheetDisplayPaperArg()
        {
            dp = DisplayPaperOut
        },
        tTabSheet = new TabSheetId() { id = moniker + "!Sheets!" + sheetKey }
    };
    // Change page border display settings
    var result = somClient.SetTabSheetDisplayPaper(tSet);
    return result;
}

SetTabSheetDisplayPaper

Syntax