CloseFieldFilterState: Операция

CloseFieldFilterStateResult CloseFieldFilterState(OdId tOb, CloseFieldFilterStateArg tArg)

Параметры

tOb. Моникёр открытого экземпляра реляционного объекта.

Описание

Операция CloseFieldFilterState закрывает область хранения настроек для автофильтра по значениям поля.

Комментарии

Перед выполнением данной операции для соответствующего поля должна быть выполнена операция CreateFieldFilterState. Между операциями CreateFieldFilterState и CloseFieldFilterState могут производиться изменения настроек автофильтра. Для этого используются операции GetFieldValues, SetFieldFilter. Для выполнения операции CloseFieldFilterState укажите в поле tOb моникёр открытого экземпляра реляционного объекта, а в поле tArg параметры закрытия. Поле tArg.add для полей источника используется один раз, при первичном создании и сохранении настроек автофильтра. В дальнейшем настройки перезаписываются при использовании поля tArg.save. В tArg также будет необходимо задать моникёр кеша реляционного объекта, который может быть получен с помощью операций GetTable/GetQuery с указанным в шаблоне полем cachedDataset.

Результатом выполнения операции будет признак успешного закрытия области хранения настроек автофильтра.

Пример

Предполагается, что имеется открытая на просмотр таблица, получен её моникёр и моникёр кеша таблицы. В таблице имеется поле с идентификатором REGION.

Ниже приведён пример закрытия области хранения настроек автофильтра для указанного поля таблицы. В запросе передаются два моникёра, идентификатор поля и выполняемое действие. В ответе возвращается признак успешного закрытия области хранения настроек.

SOAP JSON C#

SOAP-запрос:

<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>NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!TABLECMPCMBCJHDEIGOAEHNKFEHGJCOOAFFIEIJCFENIDGAPBKEPP</id>

</tOb>

<columnId>REGION</columnId>

<id>NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!CACHEDDATASETOKBHDCCJHDEIGOAEPEALCLNDILEJPILEBJGJBCLICJLOHKBD</id>

</cachedDatasetId>

<add>false</add>

</tArg>

</CloseFieldFilterState>

</s:Body>

</s:Envelope>

SOAP-ответ:

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

<soapenv:Body>

</CloseFieldFilterStateResult>

</soapenv:Body>

</soapenv:Envelope>

JSON-запрос:

{
 "CloseFieldFilterState" : 
  {
   "tOb" : 
    {
     "id" : "NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!TABLECMPCMBCJHDEIGOAEHNKFEHGJCOOAFFIEIJCFENIDGAPBKEPP"
    },
   "tArg" : 
    {
     "columnId" : "REGION",
     "cachedDatasetId" : 
      {
       "id" : "NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!CACHEDDATASETOKBHDCCJHDEIGOAEPEALCLNDILEJPILEBJGJBCLICJLOHKBD"
      },
     "save" : "true",
     "add" : "false"
    }
  }
}

JSON-ответ:

{
 "CloseFieldFilterStateResult" : 
  {
   "success" : "1"
  }
}

public static CloseFieldFilterStateResult CloseFieldFilterState(string tableMoniker, string tableCacheMoniker, string fieldId)
{
    var somClient = new SomPortTypeClient(); // Прокси-объект для выполнения операций
    // Параметры выполнения операции
    var tClose = new CloseFieldFilterState()
    {
        tArg = new CloseFieldFilterStateArg()
        {
            cachedDatasetId = new OdId() { id = tableCacheMoniker },
            columnId = fieldId,
            add = false,
            save = true
        },
        tOb = new OdId() { id = tableMoniker }
    };
    // Закрытие области хранения настроек автофильтра
    var result = somClient.CloseFieldFilterState(tClose);
    return result;
}

CloseFieldFilterState

Синтаксис