GetExpanderInfo

Syntax

GetExpanderInfoResult GetExpanderInfo()

Description

The GetExpanderInfo operation gets a list of code elements, which contents can be expanded or collapsed the macro window.

Comments

The operation does not have input parameters and results in the list of available elements. The start and end keywords will be available for each element, the code between them is hidden when collapsed. The text displayed in the macro window for the collapsed code element will also be available.

Example

Below is the example of getting a list of code elements, which contents can be expanded or collapsed in the macro window.

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">
  <GetExpanderInfo xmlns="http://www.fsight.ru/PP.SOM.Som" />
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetExpanderInfoResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<items xmlns="">
<Item>
  <startBlockText>Interface</startBlockText>
  <endBlockText>End Interface</endBlockText>
  <placeholderText>Interface</placeholderText>
  </Item>
<Item>
  <startBlockText>Class</startBlockText>
  <endBlockText>End Class</endBlockText>
  <placeholderText>Class</placeholderText>
  </Item>
<Item>
  <startBlockText>Namespace</startBlockText>
  <endBlockText>End Namespace</endBlockText>
  <placeholderText>Namespace</placeholderText>
  </Item>
<Item>
  <startBlockText>Sub</startBlockText>
  <endBlockText>End Sub</endBlockText>
  <placeholderText>Sub</placeholderText>
  </Item>
<Item>
  <startBlockText>Function</startBlockText>
  <endBlockText>End Function</endBlockText>
  <placeholderText>Function</placeholderText>
  </Item>
<Item>
  <startBlockText>Enum</startBlockText>
  <endBlockText>End Enum</endBlockText>
  <placeholderText>Enum</placeholderText>
  </Item>
<Item>
  <startBlockText>Constructor</startBlockText>
  <endBlockText>End Constructor</endBlockText>
  <placeholderText>Constructor</placeholderText>
  </Item>
<Item>
  <startBlockText>Destructor</startBlockText>
  <endBlockText>End Destructor</endBlockText>
  <placeholderText>Destructor</placeholderText>
  </Item>
<Item>
  <startBlockText>Property</startBlockText>
  <endBlockText>End Property</endBlockText>
  <placeholderText>Property ... End Property</placeholderText>
  </Item>
<Item>
  <startBlockText>Get</startBlockText>
  <endBlockText>End Get</endBlockText>
  <placeholderText>Get</placeholderText>
  </Item>
<Item>
  <startBlockText>Set</startBlockText>
  <endBlockText>End Set</endBlockText>
  <placeholderText>Set</placeholderText>
  </Item>
<Item>
  <startBlockText>For</startBlockText>
  <endBlockText>End For</endBlockText>
  <placeholderText>For ... End For</placeholderText>
  </Item>
<Item>
  <startBlockText>If</startBlockText>
  <endBlockText>End If</endBlockText>
  <placeholderText>If ... End If</placeholderText>
  </Item>
<Item>
  <startBlockText>Select</startBlockText>
  <endBlockText>End Select</endBlockText>
  <placeholderText>Select ... End Select</placeholderText>
  </Item>
<Item>
  <startBlockText>While</startBlockText>
  <endBlockText>End While</endBlockText>
  <placeholderText>While ... End While</placeholderText>
  </Item>
<Item>
  <startBlockText>Repeat</startBlockText>
  <endBlockText>Until</endBlockText>
  <placeholderText>Repeat ... Until</placeholderText>
  </Item>
<Item>
  <startBlockText>Try</startBlockText>
  <endBlockText>End Try</endBlockText>
  <placeholderText>Try ... End Try</placeholderText>
  </Item>
<Item>
  <startBlockText>With</startBlockText>
  <endBlockText>End With</endBlockText>
  <placeholderText>With ... End With</placeholderText>
  </Item>
<Item>
  <startBlockText>Comimport From</startBlockText>
  <endBlockText>End Comimport</endBlockText>
  <placeholderText>Comimport From ... End Comimport</placeholderText>
  </Item>
<Item>
  <startBlockText>Begin</startBlockText>
  <endBlockText>End</endBlockText>
  <placeholderText>Begin ... End</placeholderText>
  </Item>
<Item>
  <startBlockText>Friend</startBlockText>
  <endBlockText>End Sub</endBlockText>
  <placeholderText>Friend Sub</placeholderText>
  </Item>
<Item>
  <startBlockText>Protected Friend</startBlockText>
  <endBlockText>End Sub</endBlockText>
  <placeholderText>Protected Friend Sub</placeholderText>
  </Item>
<Item>
  <startBlockText>Friend</startBlockText>
  <endBlockText>End Function</endBlockText>
  <placeholderText>Friend Function</placeholderText>
  </Item>
<Item>
  <startBlockText>Protected Friend</startBlockText>
  <endBlockText>End Function</endBlockText>
  <placeholderText>Protected Friend Function</placeholderText>
  </Item>
<Item>
  <startBlockText>Friend</startBlockText>
  <endBlockText>End Property</endBlockText>
  <placeholderText>Friend Property ... End Property</placeholderText>
  </Item>
<Item>
  <startBlockText>Protected Friend</startBlockText>
  <endBlockText>End Property</endBlockText>
  <placeholderText>Protected Friend Property ... End Property</placeholderText>
  </Item>
<Item>
  <startBlockText>/// <summary></startBlockText>
  <endBlockText>/// </summary></endBlockText>
  <placeholderText>/// ...</placeholderText>
  </Item>
<Item>
  <startBlockText>/*</startBlockText>
  <endBlockText>*/</endBlockText>
  <placeholderText>/**/</placeholderText>
  </Item>
<Item>
  <startBlockText>{</startBlockText>
  <endBlockText>}</endBlockText>
  <placeholderText>{}</placeholderText>
  </Item>
  </items>
  </GetExpanderInfoResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
  "GetExpanderInfo": ""
}

JSON response:

{
  "GetExpanderInfoResult": {
    "items": {
      "Item": [
        {
          "startBlockText": "Interface",
          "endBlockText": "End Interface",
          "placeholderText": "Interface"
        },
        {
          "startBlockText": "Class",
          "endBlockText": "End Class",
          "placeholderText": "Class"
        },
        {
          "startBlockText": "Namespace",
          "endBlockText": "End Namespace",
          "placeholderText": "Namespace"
        },
        {
          "startBlockText": "Sub",
          "endBlockText": "End Sub",
          "placeholderText": "Sub"
        },
        {
          "startBlockText": "Function",
          "endBlockText": "End Function",
          "placeholderText": "Function"
        },
        {
          "startBlockText": "Enum",
          "endBlockText": "End Enum",
          "placeholderText": "Enum"
        },
        {
          "startBlockText": "Constructor",
          "endBlockText": "End Constructor",
          "placeholderText": "Constructor"
        },
        {
          "startBlockText": "Destructor",
          "endBlockText": "End Destructor",
          "placeholderText": "Destructor"
        },
        {
          "startBlockText": "Property",
          "endBlockText": "End Property",
          "placeholderText": "Property ... End Property"
        },
        {
          "startBlockText": "Get",
          "endBlockText": "End Get",
          "placeholderText": "Get"
        },
        {
          "startBlockText": "Set",
          "endBlockText": "End Set",
          "placeholderText": "Set"
        },
        {
          "startBlockText": "For",
          "endBlockText": "End For",
          "placeholderText": "For ... End For"
        },
        {
          "startBlockText": "If",
          "endBlockText": "End If",
          "placeholderText": "If ... End If"
        },
        {
          "startBlockText": "Select",
          "endBlockText": "End Select",
          "placeholderText": "Select ... End Select"
        },
        {
          "startBlockText": "While",
          "endBlockText": "End While",
          "placeholderText": "While ... End While"
        },
        {
          "startBlockText": "Repeat",
          "endBlockText": "Until",
          "placeholderText": "Repeat ... Until"
        },
        {
          "startBlockText": "Try",
          "endBlockText": "End Try",
          "placeholderText": "Try ... End Try"
        },
        {
          "startBlockText": "With",
          "endBlockText": "End With",
          "placeholderText": "With ... End With"
        },
        {
          "startBlockText": "Comimport From",
          "endBlockText": "End Comimport",
          "placeholderText": "Comimport From ... End Comimport"
        },
        {
          "startBlockText": "Begin",
          "endBlockText": "End",
          "placeholderText": "Begin ... End"
        },
        {
          "startBlockText": "Friend",
          "endBlockText": "End Sub",
          "placeholderText": "Friend Sub"
        },
        {
          "startBlockText": "Protected Friend",
          "endBlockText": "End Sub",
          "placeholderText": "Protected Friend Sub"
        },
        {
          "startBlockText": "Friend",
          "endBlockText": "End Function",
          "placeholderText": "Friend Function"
        },
        {
          "startBlockText": "Protected Friend",
          "endBlockText": "End Function",
          "placeholderText": "Protected Friend Function"
        },
        {
          "startBlockText": "Friend",
          "endBlockText": "End Property",
          "placeholderText": "Friend Property ... End Property"
        },
        {
          "startBlockText": "Protected Friend",
          "endBlockText": "End Property",
          "placeholderText": "Protected Friend Property ... End Property"
        },
        {
          "startBlockText": "/// &lt;summary&gt;",
          "endBlockText": "/// &lt;/summary&gt;",
          "placeholderText": "/// ..."
        },
        {
          "startBlockText": "/*",
          "endBlockText": "*/",
          "placeholderText": "/**/"
        },
        {
          "startBlockText": "{",
          "endBlockText": "}",
          "placeholderText": "{}"
        }
      ]
    }
  }
}
public static GetExpanderInfoResult GetExpanderInfo()
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetExpanderInfo();
// Get list of code elements, which can be expanded or collapsed
var result = somClient. GetExpanderInfo(tGet);
return result;
}

See also:

Working with Development Environment