Share via


WebPart.ShouldSerializeDescription method

Retorna se a propriedade Description foi alterado de seu valor padrão.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
Public Overridable Function ShouldSerializeDescription As Boolean
'Uso
Dim instance As WebPart
Dim returnValue As Boolean

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

Valor retornado

Type: System.Boolean
true se não tiver alterado o valor da propriedade do valor padrão; Caso contrário, false.

Comentários

O método ShouldSerializeDescription é fornecido, porque a propriedade Description não tem um valor padrão simples. Esse método indica se a propriedade foi alterado de seu valor padrão. Você normalmente chamar esse método se você estiver desenvolvendo um designer para a classe WebPart ou estiver criando seu próprio Web Part ou parte da ferramenta, para que você pode evitar desnecessariamente mantendo os valores padrão.

Se você substituir essa função, sua função deve retornar true se a propriedade correspondente é alterada em seu padrão ou se a propriedade SerializeAlltrue. Por exemplo:

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

Ver também

Referência

WebPart class

WebPart members

Microsoft.SharePoint.WebPartPages namespace