Поделиться через


Метод WebPart.ShouldSerializeDescription

Возвращает, изменилось ли свойство Description значения по умолчанию.

Пространство имен:  Microsoft.SharePoint.WebPartPages
Сборка:  Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
Public Overridable Function ShouldSerializeDescription As Boolean
'Применение
Dim instance As WebPart
Dim returnValue As Boolean

returnValue = instance.ShouldSerializeDescription()
public virtual bool ShouldSerializeDescription()

Возвращаемое значение

Тип: System.Boolean
true при изменении значения свойства из значения по умолчанию; в противном случае — false.

Замечания

Метод ShouldSerializeDescription предоставляется, так как свойство Description не имеет значения по умолчанию. Этот метод указывает, изменилось ли свойство значения по умолчанию. Обычно вызывается этот метод при разработке конструктора для класса WebPart или создается веб-части или инструментальной части, чтобы избежать без необходимости сохранения значения по умолчанию.

Если переопределить эту функцию, функция возвращает true при изменении соответствующего свойства по умолчанию или, если свойство SerializeAll имеет true. Например:

public override bool ShouldSerializeDescription()
{
    return SerializeAll || defaultDescription != _description;
}

См. также

Справочные материалы

WebPart класс

Элементы WebPart

Пространство имен Microsoft.SharePoint.WebPartPages