GetIntelliSenseTooltip

Syntax

GetIntelliSenseTooltipResult GetIntelliSenseTooltip(OdId tObject, GetIntelliSenseArg tArg)

Parameters

tObject. Moniker of the unit, with which code the work is executed.

tArg. Operation execution parameters.

Description

The GetIntelliSenseTooltip operation gets information used on creating a tooltip for type of cype member in the unit code.

Comments

To execute the operation, in the tObject field specify unit moniker and in the tArg.cursor field specify the cursor layout coordinates in the code. If the unit was changed but it has not been saved yet, its code can be passed in the tArg.meta field. The operation results in the collection of code elements that can be used in the specified code coordinate.

Example

Below is the example of getting information about type member that is used to generate a tooltip. The unit moniker and code coordinate are sent in the query. The information about type member and its parameters is received in the response. The example uses the FindObjectById function, which code is given in the Getting Object Description by Its Identifier example.

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">
<GetIntelliSenseTooltip xmlns="http://www.fsight.ru/PP.SOM.Som">
<tObject xmlns="">
  <id>EBNIJHOJBFHOFOAEMHDCCHPHGKHABKGEPKLBOEMGMNCFCAIK!M!172002</id>
  </tObject>
<tArg xmlns="">
<cursor>
  <col>48</col>
  <row>26</row>
  </cursor>
  </tArg>
  </GetIntelliSenseTooltip>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetIntelliSenseTooltipResult 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">
<tooltip xmlns="">
  <type>Sub</type>
  <name>CreateWithParams</name>
  <access>Public</access>
<blocks>
<it>
  <type>Var</type>
  <name>Size</name>
  <typeName>Integer</typeName>
  <access>Public</access>
  <imask>4</imask>
  </it>
<it>
  <type>Var</type>
  <name>DefaultValue</name>
  <typeName>Double</typeName>
  <Value>0</Value>
  <access>Public</access>
  <imask>4</imask>
  </it>
  </blocks>
  <imask>2</imask>
  </tooltip>
  <selectedChild xmlns="">1</selectedChild>
  </GetIntelliSenseTooltipResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetIntelliSenseTooltip" :
{
"tObject" :
{
"id" : "EBNIJHOJBFHOFOAEMHDCCHPHGKHABKGEPKLBOEMGMNCFCAIK!M!172002"
},
"tArg" :
{
"cursor" :
{
"col" : "48",
"row" : "26"
}
}
}
}

JSON response:

{
"GetIntelliSenseTooltipResult" :
{
"tooltip" :
{
"type" : "Sub",
"name" : "CreateWithParams",
"access" : "Public",
"blocks" :
{
"it" :
[
{
"type" : "Var",
"name" : "Size",
"typeName" : "Integer",
"access" : "Public",
"imask" : "4"
},
{
"type" : "Var",
"name" : "DefaultValue",
"typeName" : "Double",
"Value" : "0",
"access" : "Public",
"imask" : "4"
}
]
},
"imask" : "2"
},
"selectedChild" : "1"
}
}
public static GetIntelliSenseTooltipResult GetIntelliSenseTooltip(MbId mb, string moduleId)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetIntelliSenseTooltip()
{
tArg = new GetIntelliSenseArg()
{
cursor = new CodePoint()
{
row = 26,
col = 48
}
},
// Unit moniker
tObject = new OdId() { id = mb.id + "!" + FindObjectById(mb, moduleId).k }
};
// Get information
var result = somClient.GetIntelliSenseTooltip(tGet);
return result;
}

See also:

Working with Development Environment