Class StyleInfoProperty

Provides a unique identifier for a property in a style object and stores information about the associated property.

Inheritance

System.Object

StyleInfoProperty

Namespace: Syncfusion.Windows.Styles

Assembly: Syncfusion.GridCommon.WPF.dll

Syntax

public class StyleInfoProperty : Object

Remarks

StyleInfoProperty is allocated once on the global heap for each property in a style object. Type safe StyleInfoBase wrappers make use of StyleInfoProperty to query, set or reset specific properties.

Holds information about the property: PropertyType, Name, how to load and save its state in StyleInfoStore, attributes, etc.

Fields

ComponentType

The type of the component this property is bound to.

Declaration

public Type ComponentType

Field Value

Type
System.Type

CreateObject

Represents a method that creates a Subobject of this type and associates it with a parent style object.

Declaration

public CreateSubObjectHandler CreateObject

Field Value

Type
Syncfusion.Windows.Styles.CreateSubObjectHandler

DoNotInvalidateCellWhenChanged

Set this for "behind the scenes" properties that when changed do not affect the appearance of a cell.

Declaration

public bool DoNotInvalidateCellWhenChanged

Field Value

Type
System.Boolean

IsAnyObject

Indicates whether type information should be included when Format is called. Use this if PropertyType is System.Obbject and you want to be able to parse written values. An example is GridStyleInfo.CellValue. Default is false.

Declaration

public bool IsAnyObject

Field Value

Type
System.Boolean

IsBrowsable

If property is marked with Browsable(true), custom attribute of this flag allows you to specify whether the property should appear in PropertyGrid. If property is marked with Browsable(false), then this setting will have no effect. Default is true.

Declaration

public bool IsBrowsable

Field Value

Type
System.Boolean

IsCloneable

Indicates whether this object should call ICloneable.Clone when an assigned object implements the ICloneable or IStyleCloneable interface. The value can be set with a CloneablePropertyAttribute in your class implementation.

Declaration

public bool IsCloneable

Field Value

Type
System.Boolean

IsConvertibleToBase64

Indicates whether type information should be converted to Base64 if associated Type converter supports converting value to and from Base64. An example is a bitmap assigned to GridStyleInfo.CellValue. If IsConvertibleToBase64String is true, then the grid will convert the bitmap to a Base64 string and write out the information in the GridStyleInfo.ToString() method and also in the WriteXml method. Default is false.

Declaration

public bool IsConvertibleToBase64

Field Value

Type
System.Boolean

IsDisposable

Indicates whether this object should call ICloneable.Clone when an assigned object implements the IDisposable or IStyleCloneable interface. The value can be set also with a DisposeablePropertyAttribute in your class implementation.

Declaration

public bool IsDisposable

Field Value

Type
System.Boolean

IsExpandable

Indicates whether this is an object derived from StyleInfoSubObjectBase.

Declaration

public bool IsExpandable

Field Value

Type
System.Boolean

IsSerializable

Indicates whether this object supports being serialized. The value can be set with a SerializePropertyAttribute in your class implementation.

Declaration

public bool IsSerializable

Field Value

Type
System.Boolean

PropertyName

The name of the property.

Declaration

public string PropertyName

Field Value

Type
System.String

PropertyType

The type of the property.

Declaration

public Type PropertyType

Field Value

Type
System.Type

SerializeXmlBehavior

Defines how to serialize property when style data is serialized to or from an XML stream with System.Xml.Serialization.XmlSerializer.

Declaration

public SerializeXmlBehavior SerializeXmlBehavior

Field Value

Type
SerializeXmlBehavior

Methods

add_Format(StyleInfoPropertyConvertEventHandler)

Declaration

public void add_Format(StyleInfoPropertyConvertEventHandler value)

Parameters

Type	Name	Description
StyleInfoPropertyConvertEventHandler	value

add_Parse(StyleInfoPropertyConvertEventHandler)

Declaration

public void add_Parse(StyleInfoPropertyConvertEventHandler value)

Parameters

Type	Name	Description
StyleInfoPropertyConvertEventHandler	value

add_ReadXml(StyleInfoPropertyReadXmlEventHandler)

Declaration

public void add_ReadXml(StyleInfoPropertyReadXmlEventHandler value)

Parameters

Type	Name	Description
StyleInfoPropertyReadXmlEventHandler	value

add_WriteXml(StyleInfoPropertyWriteXmlEventHandler)

Declaration

public void add_WriteXml(StyleInfoPropertyWriteXmlEventHandler value)

Parameters

Type	Name	Description
StyleInfoPropertyWriteXmlEventHandler	value

FormatValue(Object)

Formats a given value that is of the same type as the PropertyType.

Declaration

public string FormatValue(object value)

Parameters

Type	Name	Description
System.Object	value	The value to be formatted.

Returns

Type	Description
System.String	A string with formatted text.

Remarks

ToString() calls this method.

The Format event lets you customize the formatting of this property but care should be taken that the formatted text can be consumed by the ParseValue(String) method.

GetPropertyDescriptor()

Declaration

public PropertyDescriptor GetPropertyDescriptor()

Returns

Type
System.ComponentModel.PropertyDescriptor

GetPropertyInfo()

Returns the System.Reflection.PropertyInfo of this property.

Declaration

public PropertyInfo GetPropertyInfo()

Returns

Type	Description
System.Reflection.PropertyInfo	Property info of this property.

ParseValue(String)

Overloaded. Parses a given value that is of the same type as the PropertyType.

Declaration

public object ParseValue(string s)

Parameters

Type	Name	Description
System.String	s	The string to be parsed.

Returns

Type	Description
System.Object	An object of the same type as the PropertyType created from the parsed string information.

Remarks

ParseString(String) calls this method.

The Parse event lets you customize the parsing of this property.

ParseValue(String, Type, IFormatProvider)

Parses a given value and converts it to a requested System.Type.

Declaration

public static object ParseValue(string s, Type resultType, IFormatProvider provider)

Parameters

Type	Name	Description
System.String	s	The string to be parsed.
System.Type	resultType	The System.Type for the resulting object.
System.IFormatProvider	provider	A format provider.

Returns

Type	Description
System.Object	An object of type "resultType" created from the parsed string information.

Remarks

The Parse event lets you customize the parsing of this property.

remove_Format(StyleInfoPropertyConvertEventHandler)

Declaration

public void remove_Format(StyleInfoPropertyConvertEventHandler value)

Parameters

Type	Name	Description
StyleInfoPropertyConvertEventHandler	value

remove_Parse(StyleInfoPropertyConvertEventHandler)

Declaration

public void remove_Parse(StyleInfoPropertyConvertEventHandler value)

Parameters

Type	Name	Description
StyleInfoPropertyConvertEventHandler	value

remove_ReadXml(StyleInfoPropertyReadXmlEventHandler)

Declaration

public void remove_ReadXml(StyleInfoPropertyReadXmlEventHandler value)

Parameters

Type	Name	Description
StyleInfoPropertyReadXmlEventHandler	value

remove_WriteXml(StyleInfoPropertyWriteXmlEventHandler)

Declaration

public void remove_WriteXml(StyleInfoPropertyWriteXmlEventHandler value)

Parameters

Type	Name	Description
StyleInfoPropertyWriteXmlEventHandler	value

ToString()

Declaration

public override string ToString()

Returns

Type
System.String

Events

Format

Handles formatting requests for this property.

Declaration

public event StyleInfoPropertyConvertEventHandler Format

Event Type

Type
StyleInfoPropertyConvertEventHandler

Parse

Handles parse requests for this property.

Declaration

public event StyleInfoPropertyConvertEventHandler Parse

Event Type

Type
StyleInfoPropertyConvertEventHandler

ReadXml

Handles requests to deserialize this property from an XML stream during an System.Xml.Serialization.XmlSerializer.Deserialize(System.IO.Stream) operation of the System.Xml.Serialization.XmlSerializer class.

Declaration

public event StyleInfoPropertyReadXmlEventHandler ReadXml

Event Type

Type
StyleInfoPropertyReadXmlEventHandler

Remarks

This event allows you to implement a different serialization mechanism if many style objects reference and share the same object, (e.g. if you assign a DataSet to several objects DataSource property). With such a scenario, you could write out an identifier and when the property is deserialized from an XML stream you could reconstruct a reference to a datasource object based on the identifier.

WriteXml

Handles requests to serialize this property to an XML stream during an System.Xml.Serialization.XmlSerializer.Serialize(System.IO.Stream,System.Object) operation of the System.Xml.Serialization.XmlSerializer class.

Declaration

public event StyleInfoPropertyWriteXmlEventHandler WriteXml

Event Type

Type
StyleInfoPropertyWriteXmlEventHandler

Remarks

This event allows you to implement a different serialization mechanism if many style objects reference and share the same object, (e.g. if you assign a DataSet to several objects DataSource property). With such a scenario, you could write out an identifier and when the property is deserialized from an XML stream, you could reconstruct a reference to a datasource object based on the identifier.