[]
        
(Showing Draft Content)

GrapeCity.Wpf.SpreadSheet.CellType.Editors.GcMask

GcMask Class

Represents an editor control with specified format which can be user-defined.

Namespace: GrapeCity.Wpf.SpreadSheet.CellType.Editors
Assembly: GrapeCity.Wpf.SpreadSheet.CellType.dll
Syntax
[StyleTypedProperty(Property = "SpinButtonStyle", StyleTargetType = typeof(SpinButton))]
[TemplateVisualState(GroupName = "SpinButtonStates", Name = "SpinButtonCollapsed")]
[TemplateVisualState(GroupName = "SpinButtonStates", Name = "SpinButtonVisible")]
[TemplateVisualState(Name = "InsertState", GroupName = "EditModeStates")]
[TemplateVisualState(Name = "OverwriteState", GroupName = "EditModeStates")]
[TemplateVisualState(Name = "ActiveDropDown", GroupName = "ActiveStates")]
public class GcMask : FieldsEditorControl, IAnimatable, IFrameworkInputElement, IInputElement, IQueryAmbient, IAddChild, ISupportInitialize
<StyleTypedProperty(Property:="SpinButtonStyle", StyleTargetType:=GetType(SpinButton))>
<TemplateVisualState(GroupName:="SpinButtonStates", Name:="SpinButtonCollapsed")>
<TemplateVisualState(GroupName:="SpinButtonStates", Name:="SpinButtonVisible")>
<TemplateVisualState(Name:="InsertState", GroupName:="EditModeStates")>
<TemplateVisualState(Name:="OverwriteState", GroupName:="EditModeStates")>
<TemplateVisualState(Name:="ActiveDropDown", GroupName:="ActiveStates")>
Public Class GcMask
    Inherits FieldsEditorControl
    Implements IAnimatable, IFrameworkInputElement, IInputElement, IQueryAmbient, IAddChild, ISupportInitialize
Remarks

Users can add different GrapeCity.Windows.InputMan.Fields.MaskField to GcMask to set up various format for purpose. It support text filter field, literal display field and enumeration selection field.

Users can also display watermark string for tips to notify current GcMask status. By setting WatermarkNull and WatermarkDisplayNull, users can show different strings when GcMask has null content.

Supported VisualState list:

l

VisualStateGroup Name

VisualState Name

Description

CommonStates

Normal

Represents the visual appearance when control is in normal state.

CommonStates

Disabled

Represents the visual appearance when IsEnabled is false.

CommonStates

ReadOnly

Represents the visual appearance when IsReadOnly is true.

CommonStates

MouseOver

Represents the visual appearance when IsMouseOver is true.

ActiveStates

Active

Represents the visual appearance when IsActive is true.

ActiveStates

Inactive

Represents the visual appearance when IsActive is false.

InputStates

Full

Represents the visual appearance when IsFull is true.

InputStates

Completed

Represents the visual appearance when IsCompleted is true.

InputStates

Empty

Represents the visual appearance when IsEmpty is true.

InputStates

Part

Represents the visual appearance when IsFull, IsCompleted and IsEmpty all are false.

ValidationStates

Valid

Represents the visual appearance when System.Windows.Controls.Validation.GetHasError(System.Windows.DependencyObject) returns false.

ValidationStates

InvalidFocused

Represents the visual appearance when System.Windows.Controls.Validation.GetHasError(System.Windows.DependencyObject) returns true and control has focus.

ValidationStates

InvalidUnfocused

Represents the visual appearance when System.Windows.Controls.Validation.GetHasError(System.Windows.DependencyObject) returns true and control has no focus.

Constructors

Name Description
GcMask()

Initializes a new instance of the GcMask class.

Fields

Name Description
AutoConvertProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.AutoConvert dependency property.

DefaultActiveFieldIndexProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.DefaultActiveFieldIndex dependency property.

ExitOnLastCharProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.ExitOnLastChar dependency property.

FieldSetProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.FieldSet dependency property.

HighlightTextProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.HighlightText dependency property.

PromptCharProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.PromptChar dependency property.

RecommendedValueProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.RecommendedValue dependency property.

ShowLiteralsProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.ShowLiterals dependency property.

ShowRecommendedValueProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.ShowRecommendedValue dependency property.

SpinButtonStyleProperty

Indicates the SpinButtonStyle dependency property.

SpinButtonVisibilityProperty

Indicates the SpinButtonVisibility dependency property.

TabActionProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.TabAction dependency property.

ValueChangedEvent

Identifies the GrapeCity.Windows.InputMan.GcMask.ValueChanged routed event.

ValueProperty

Identifies the GrapeCity.Windows.InputMan.GcMask.Value dependency property.

Properties

Name Description
ActiveField

Gets the current active field which can show the caret and accept input.

ApplyRecommendedValueCommand

Represents the ApplyRecommendedValueCommand command, which requests that recommended value be applied.

AutoConvert

Gets or set whether to automatically convert the entered characters according to the input control.

This is a Dependency Property.

DefaultActiveFieldIndex

Gets or sets the index of default active editable field. This is a dependency property.

ExitOnLastChar

Gets or sets whether or not the next control in the tab order receives the focus as soon as the control is filled at the last character.

FieldSet

Gets or sets a GrapeCity.Windows.InputMan.Fields.MaskFieldSet which indicate the wrapper of all fields in GrapeCity.Windows.InputMan.GcMask. This is a dependency property.

HighlightText

Gets or sets how to select the text when the control receives the focus.

PromptChar

Gets or sets the character used as a prompt for input.

RecommendedValue

Gets or sets the recommended value.

ShowLiterals

Gets or sets whether to display the literals during user entry.

ShowRecommendedValue

Gets or sets a value indicating whether show the recommended value.

SpinButtonStyle

Gets or sets the spin button style which used when spin button is rendered.

SpinButtonVisibility

Gets or sets the GrapeCity.Windows.InputMan.ButtonVisibility of the spin side button. This is a dependency property.

TabAction

Gets or sets to determine whether the tab key moves the focus between controls or between fields within the control.

Value

Gets or sets the underlying value assigned to the control.

Methods

Name Description
OnValueChanged(RoutedEventArgs)

Raise the GrapeCity.Windows.InputMan.GcMask.ValueChanged routed event.

Events

Name Description
ValueChanged

Occurs when the value property changes in GrapeCity.Windows.InputMan.GcMask.