Задаёт текстовое описание слоя.

Применяется к:

Layer

Синтаксис:

Visual Basic:

Function SetDescription(sText As String) As Boolean

sText - текст описания.

Описание:

Описание хранится вместе со слоем и сохраняется после его повторного открытия; прочитать его можно методом GetDescription. Текст может содержать переводы строк. Пустая строка удаляет описание.

Метод возвращает True, если описание записано, и False, если записать его не удалось — например, слой недоступен для записи.

Пример:

Visual Basic:

Sub Layer_SetDescription
'Берем активный слой карты
Set L = Zulu.ActiveMapDoc.Layers.Active
'Записываем описание из двух строк
If L.SetDescription("Сеть теплоснабжения" & vbCrLf & "Обновлено: " & Date) Then
  MsgBox "Описание слоя:" & vbCrLf & L.GetDescription
Else
  MsgBox "Описание записать не удалось"
End If
End Sub

Python:

import zulu, datetime

def Macro_Layer_SetDescription():
    # Берем активный слой карты
    L = zulu.App.ActiveMapDoc.Layers.Active
    # Записываем описание из двух строк
    text = "Сеть теплоснабжения\r\nОбновлено: " + datetime.date.today().strftime("%d.%m.%Y")
    if L.SetDescription(text):
        print("Описание слоя:")
        print(L.GetDescription())
    else:
        print("Описание записать не удалось")