Share via


ElementPropertyDescriptor.ShouldSerializeValue Method

Indicates whether the value of the domain property should be serialized.

Namespace:  Microsoft.VisualStudio.Modeling.Design
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.11.0.dll)

Syntax

'Declaration
Public Overrides Function ShouldSerializeValue ( _
    component As Object _
) As Boolean
public override bool ShouldSerializeValue(
    Object component
)
public:
virtual bool ShouldSerializeValue(
    Object^ component
) override
abstract ShouldSerializeValue : 
        component:Object -> bool  
override ShouldSerializeValue : 
        component:Object -> bool
public override function ShouldSerializeValue(
    component : Object
) : boolean

Parameters

  • component
    Type: Object

    The domain element for which to set the value of the property.

Return Value

Type: Boolean
true if the value of the domain property should be serialized; otherwise, false.

Remarks

By default, the property value is serialized if the value is different from the default value of the property. This behavior can be changed in a derived class.

If the ModelElement property of the descriptor is nulla null reference (Nothing in Visual Basic), then the component parameter is used as the model element on which to check the property value; otherwise, this method checks the value of the property from the model element with which it is associated. This association is formed when the property descriptor is created.

.NET Framework Security

See Also

Reference

ElementPropertyDescriptor Class

Microsoft.VisualStudio.Modeling.Design Namespace

ElementPropertyDescriptor

ModelElement

GetValue