Class GridErrorStyleInfo

Used to display error tool tips for the cells.

Inheritance
System.Object
StyleInfoBase
StyleInfoSubObjectBase
GridErrorStyleInfo
Implements
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Windows.Controls.Grid
Assembly: Syncfusion.Grid.Wpf.dll
Syntax
public class GridErrorStyleInfo : StyleInfoSubObjectBase, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

Constructors

GridErrorStyleInfo()

Initializes a new empty GridErrorStyleInfo object.

Declaration
public GridErrorStyleInfo()

GridErrorStyleInfo(StyleInfoSubObjectIdentity)

Initalizes a new GridErrorStyleInfo object and associates it with an existing .

Declaration
public GridErrorStyleInfo(StyleInfoSubObjectIdentity identity)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A that holds the indentity for this GridErrorStyleInfo.

GridErrorStyleInfo(StyleInfoSubObjectIdentity, GridErrorStyleInfoStore)

Initalizes a new GridErrorStyleInfo object and associates it with an existing .

Declaration
public GridErrorStyleInfo(StyleInfoSubObjectIdentity identity, GridErrorStyleInfoStore store)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A that holds the indentity for this GridErrorStyleInfo.
GridErrorStyleInfoStore store

A GridErrorStyleInfoStore that holds data for this GridErrorStyleInfo. All changes in this style object will be saved in the GridErrorStyleInfoStore object.

Properties

CustomImage

Gets or sets a custom image to use in the place of error icon.

Declaration
public BitmapImage CustomImage { get; set; }
Property Value
Type Description
System.Windows.Media.Imaging.BitmapImage

Default

Gets the default style for GridErrorStyleInfo object.

Declaration
public static GridErrorStyleInfo Default { get; }
Property Value
Type Description
GridErrorStyleInfo

ErrorContentAlignment

Gets or sets the error content alignment.

Declaration
public ImageContentAlignment ErrorContentAlignment { get; set; }
Property Value
Type Description
ImageContentAlignment
Remarks

The ErrorContentAlignment property doesn't support Center. Only Left and Right alignments are supported.

ErrorMessage

Gets or sets the error message.

Declaration
public string ErrorMessage { get; set; }
Property Value
Type Description
System.String

ErrorTooltipBackgroundBrush

Gets or sets the background for error tooltip.

Declaration
public Brush ErrorTooltipBackgroundBrush { get; set; }
Property Value
Type Description
System.Windows.Media.Brush

ErrorTooltipForegroundBrush

Gets or sets the foreground for error tooltip.

Declaration
public Brush ErrorTooltipForegroundBrush { get; set; }
Property Value
Type Description
System.Windows.Media.Brush

ErrorTooltipTemplateKey

Gets or sets the template for the error tooltip.

Declaration
public string ErrorTooltipTemplateKey { get; set; }
Property Value
Type Description
System.String

ErrorType

Gets or sets the Error Type.

Declaration
public ErrorType ErrorType { get; set; }
Property Value
Type Description
ErrorType

HasCustomImage

Specifies whether the CustomImage property is initialized.

Declaration
public bool HasCustomImage { get; }
Property Value
Type Description
System.Boolean

HasErrorContentAlignment

Specifies whether the ErrorContentAlignment property is initialized.

Declaration
public bool HasErrorContentAlignment { get; }
Property Value
Type Description
System.Boolean

HasErrorMessage

Specifies whether the ErrorMessage property is initialized.

Declaration
public bool HasErrorMessage { get; }
Property Value
Type Description
System.Boolean

HasErrorTooltipBackgroundBrush

Specifies whether the ErrorTooltipBackgroundBrush property is initialized.

Declaration
public bool HasErrorTooltipBackgroundBrush { get; }
Property Value
Type Description
System.Boolean

HasErrorTooltipForegroundBrush

Specifies whether the ErrorTooltipForegroundBrush property is initialized.

Declaration
public bool HasErrorTooltipForegroundBrush { get; }
Property Value
Type Description
System.Boolean

HasErrorTooltipTemplateKey

Specifies whether the ErrorTooltipTemplateKey property is initialized.

Declaration
public bool HasErrorTooltipTemplateKey { get; }
Property Value
Type Description
System.Boolean

HasErrorType

Specifies whether the ErrorType property is initialized.

Declaration
public bool HasErrorType { get; }
Property Value
Type Description
System.Boolean

HasImageHeight

Specifies whether the ImageHeight property is initialized.

Declaration
public bool HasImageHeight { get; }
Property Value
Type Description
System.Boolean

HasImageMargins

Specifies whether the ImageMargins property is initialized.

Declaration
public bool HasImageMargins { get; }
Property Value
Type Description
System.Boolean

HasImageWidth

Specifies whether the ImageWidth property is initialized.

Declaration
public bool HasImageWidth { get; }
Property Value
Type Description
System.Boolean

ImageHeight

Gets or sets the height of the error icon.

Declaration
public GridLength ImageHeight { get; set; }
Property Value
Type Description
System.Windows.GridLength

ImageMargins

Defines the margins for the error icon.

Declaration
public CellMarginsInfo ImageMargins { get; set; }
Property Value
Type Description
CellMarginsInfo

ImageWidth

Gets or sets the width of the error icon.

Declaration
public GridLength ImageWidth { get; set; }
Property Value
Type Description
System.Windows.GridLength

ReadOnlyErrorContentAlignment

Returns the error content alignment.

Declaration
public ImageContentAlignment ReadOnlyErrorContentAlignment { get; }
Property Value
Type Description
ImageContentAlignment

ReadOnlyErrorTooltipBackgroundBrush

Declaration
public Brush ReadOnlyErrorTooltipBackgroundBrush { get; }
Property Value
Type Description
System.Windows.Media.Brush

ReadOnlyErrorTooltipForegroundBrush

Declaration
public Brush ReadOnlyErrorTooltipForegroundBrush { get; }
Property Value
Type Description
System.Windows.Media.Brush

ReadOnlyErrorType

Returns the read only error type.

Declaration
public ErrorType ReadOnlyErrorType { get; }
Property Value
Type Description
ErrorType

ReadOnlyImageHeight

Declaration
public GridLength ReadOnlyImageHeight { get; }
Property Value
Type Description
System.Windows.GridLength

ReadOnlyImageMargins

Gets the margins of error image.

Declaration
public CellMarginsInfo ReadOnlyImageMargins { get; }
Property Value
Type Description
CellMarginsInfo

ReadOnlyImageWidth

Declaration
public GridLength ReadOnlyImageWidth { get; }
Property Value
Type Description
System.Windows.GridLength

Methods

AdjustErrorInfoMargin(Thickness, GridControlBase, RowColumnIndex)

Adjusts the margin of error info display according to the client area.

Declaration
public Thickness AdjustErrorInfoMargin(Thickness defaultMargin, GridControlBase grid, RowColumnIndex rowColIndex)
Parameters
Type Name Description
System.Windows.Thickness defaultMargin

Default margin.
GridControlBase grid

The grid.
RowColumnIndex rowColIndex

Row index.
Returns
Type Description
System.Windows.Thickness

Adjusted margin.

AdjustErrorInfoMargin(Thickness, Size)

Adjusts the margin of error info display according to the client area.

Declaration
public Thickness AdjustErrorInfoMargin(Thickness defaultMargin, Size clientSize)
Parameters
Type Name Description
System.Windows.Thickness defaultMargin

Default margin.
System.Windows.Size clientSize

Client size.
Returns
Type Description
System.Windows.Thickness

Adjusted margin.

AdjustErrorInfoMarginOnEditing(Thickness, GridControlBase, RowColumnIndex)

Declaration
public Thickness AdjustErrorInfoMarginOnEditing(Thickness defaultMargin, GridControlBase grid, RowColumnIndex rowColIndex)
Parameters
Type Name Description
System.Windows.Thickness defaultMargin
GridControlBase grid
RowColumnIndex rowColIndex
Returns
Type Description
System.Windows.Thickness

AdjustImageMargins(Rect)

Adjusts the image margins according to the client rectangle.

Declaration
public Rect AdjustImageMargins(Rect rectangle)
Parameters
Type Name Description
System.Windows.Rect rectangle

Client rectangle.
Returns
Type Description
System.Windows.Rect

Adjusted margins.

CreateSubObjectIdentity(StyleInfoProperty)

Creates a product-specific identity object for a sub object.

Declaration
public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip)
Parameters
Type Name Description
StyleInfoProperty sip

Sub object.
Returns
Type Description
StyleInfoSubObjectIdentity

An identity object for a subobject of this style.
Overrides

GetDefaultStyle()

Returns Default.

Declaration
protected override StyleInfoBase GetDefaultStyle()
Returns
Type Description
StyleInfoBase

A GridErrorStyleInfo object with default values.
Overrides

GetImageHeight()

Declaration
public double GetImageHeight()
Returns
Type Description
System.Double

GetImageWidth()

Declaration
public double GetImageWidth()
Returns
Type Description
System.Double

ResetCustomBrush()

Resets the CustomImage property.

Declaration
public void ResetCustomBrush()

ResetErrorContentAlignment()

Resets the ErrorContentAlignment property.

Declaration
public void ResetErrorContentAlignment()

ResetErrorMessage()

Resets the ErrorMessage property.

Declaration
public void ResetErrorMessage()

ResetErrorTooltipBackgroundBrush()

Resets the ErrorTooltipBackgroundBrush property.

Declaration
public void ResetErrorTooltipBackgroundBrush()

ResetErrorTooltipForegroundBrush()

Resets the ErrorTooltipForegroundBrush property.

Declaration
public void ResetErrorTooltipForegroundBrush()

ResetErrorTooltipTemplateKey()

Resets the ErrorTooltipTemplateKey property.

Declaration
public void ResetErrorTooltipTemplateKey()

ResetErrorType()

Resets the ErrorType property.

Declaration
public void ResetErrorType()

ResetImageHeight()

Resets the ImageHeight property.

Declaration
public void ResetImageHeight()

ResetImageMargins()

Resets the ImageMargins property.

Declaration
public void ResetImageMargins()

ResetImageWidth()

Resets the ImageWidth property.

Declaration
public void ResetImageWidth()

Implements

System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable