Version

ToggleEditorBase Class Members

The following tables list the members exposed by ToggleEditorBase.

Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyCanFocusOverridden. The editor can take focus while in edit mode  
Public PropertyCheckAlignControls the alignment of the checkbox  
Public PropertyCheckedAppearanceChecked appearance for the object  
Public PropertyCheckStateThe CheckState of the editor  
Public PropertyCurrentEditTextOverridden. Returns the current text being edited without doing any validation. This will return the text currently typed in. If the editor does not have an textbox-like control, it will return the current edit value in form of text.  
Public PropertyDataFilterIf different than null, specifies custom data filter used by the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyDefaultOwnerReturns the default embeddable editor owner, which may provide default owner-specific values for an editor (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyEditorSharedObjectNameSpecifies name of the shared object that was defined for this editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyElementBeingEditedReturns the embeddable element that is currently in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyExpectedTypeDefault type used by the editor in the case of data filter. Null means that editor supports multiple data types and expects type to be set or provided by the owner. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyFocusedOverridden. Returns true if the editor has focus (read-only).  
Public PropertyGlyphTypeReturns the type of glpyh (checkbox or radio button) being used by the editor.  
Public PropertyHasCheckedAppearanceReturns whether or not the control has a checked appearance  
Public PropertyHasHotTrackingAppearanceReturns whether or not the control has a hot tracking appearance  
Public PropertyHasIndeterminateAppearanceReturns whether or not the control has an check indeterminate appearance  
Public PropertyHotTrackingAppearanceDown Checkbox appearance for the object  
Public PropertyIndeterminateAppearanceIndeterminate Checkbox appearance for the object  
Public PropertyIsDroppedDownReturns true if in edit mode and dropped down (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyIsInEditModeReturns true if the editor is in edit mode (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyIsValidOverridden. Returns true if the edited value is valid (read-only).  
Public PropertySelectedTextGets or sets the currently selected text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySelectionLengthGets or sets the number of characters selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySelectionStartGets or sets the starting point of text selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyStyleSet/Get the view style of the editor  
Public PropertySupportsAutoSizeEditSpecifies whether the editor supports AutoSizeEdit (read-only). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsDropDownReturns true if this editor supports a dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsSelectableTextReturns true if this editor supports selecting text. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsSpellCheckingReturns true if this editor supports spell checking. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsValueListSpecifies whether the editor supports value list (read-only). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTextControls the text of the caption that will be displayed with the check  
Public PropertyTextLengthGets the length of the text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyValueOverridden. The current value being edited.  
Protected Properties
 NameDescription
Protected PropertyHasOwnDefaultContextMenuProperty which should be overriden by derived editors which have their own default Context Menu, so an ancestor's ContextMenu would be prevented from showing. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertySelectedTextInternalGets or sets the currently selected text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertySelectionLengthInternalGets or sets the number of characters selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertySelectionStartInternalGets or sets the starting point of text selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Protected PropertyTextLengthInternalGets the length of the text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertyWantsOwnerKeyEventsOverridden. WantsOwnerKeyEvents  
Public Methods
 NameDescription
Public MethodApplyValueAppearanceApplies any appearance associated with the dataVal data value. Base implementation does nothing. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodAreTouchMetricsEnabledReturns whether Touch mode is currently enabled on this control. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodCanEditTypeOverridden. This editor only edits boolean and string values.  
Public MethodCanRenderTypeOverridden. Only Boolean and string types can be rendered by this editor  
Public MethodCloneCreates a copy of the embeddable editor with the specified default owner. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodCloseUpCalled to have the dropdown close up. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodComparesByValueReturns whether the owner should compare items based on their underlying value rather than their display text. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodCreateAccessibilityInstanceUsed by an editor owner to create an accessible object for a specific object managed by an editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodCreateUIAutomationProviderUsed by an editor owner to create a UI Automation provider for a specific object managed by an editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodDataValueToTextOverloaded. Converts data value to text making use of any format provider and format strings that owner may provide. If unsuccessful, returns null. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodDropDownCalled to drop down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodEnterEditModeCalled to place the editor in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodExitEditModeCalled to have the editor exit edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodFocusOverridden. Sets input focus to the editor.  
Public MethodGetDropDownStateReturns information about whether the dropdown is dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodGetEditStatusReturns information about whether the object is in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodGetEmbeddableElementOverloaded. Called from inside the UIElement.PositionChildElements method of the parent element to create and position the embedded element or elements. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodGetEmbeddableElementTypeReturns the type of the EmbeddableUIElementBase derived class that this editor uses as it's embeddable element. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetOwnerCheckStateOverloaded. Returns the the value of the Owner as a CheckState  
Public MethodGetSizeOverloaded. Overridden. Used to determine the size preferred/required by the editor.  
Public MethodGetSpellCheckTargetGets the current spell check target (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodIsInputKeyOverridden. Returns whether the key is used by the editor.  
Public MethodIsValidValueReturns true if the edited value is valid (read-only). If the value is invalid, the 'errorMessage' out parameter can contain an error message. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodOnTouchMetricsChangedCalled when the TouchProvider's state or registration has changed (e.g. when its Visble or Enabled property has changed). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodResetCheckedAppearanceCalled by environment to reset property.  
Public MethodResetHotTrackingAppearanceCalled by environment to reset property.  
Public MethodResetIndeterminateAppearanceCalled by environment to reset property.  
Public MethodResolveAppearanceOverloaded. Resolves the elements appearance.  
Public MethodSelectAllSelects all text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodShouldSerializeCheckedAppearanceCalled to determine if Appearance should be serialized  
Public MethodShouldSerializeHotTrackingAppearanceCalled to determine if Appearance should be serialized  
Public MethodShouldSerializeIndeterminateAppearanceCalled to determine if Appearance should be serialized  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodValueToDataValueOverloaded. Converts val to an object of type returned by owner's GetDataType method. If it can not convert, it returns null. It makes use of any format provided and format string off the owner. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodAdjustSizeForOwnerBordersAdjusts the specified Size to account for the owner-specified borders (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodAdjustSizeForOwnerPaddingAdjusts (increases) the specified size for the owner padding. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodDoCloseUpCloses the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodDoDropDownDrops down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetAutoConvertedDestinationValueOverridden. Override this in specific editor to provide automatic conversions for that editor.  
Protected MethodGetDisplayValueOverride this in specific editor to provide display value. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetEditorValueOverridden. Override this in specific editor to provide editor value.  
Protected MethodGetInkProviderGets the InkProvider registered for the owner's container. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetTextSizeOfValueReturns the size required to render the editor's value for the specified owner and ownerContext. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodHookOwnersKeyEventsStart listening to the owner's key events (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodInitializeFromOverridden. Initializes the state of this object from a source object of the same type  
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodIsDestinationValueValidOverride this in specific editor to check if converted value is valid. Note, this value does not use the ValueConstraint object returned by the owner's GetConstraints method during validation. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnAfterCheckStateChangedFires the AfterCheckStateChanged event  
Protected MethodOnAfterCloseUpCalled after the dropdown has been closed up. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnAfterDropDownCalled after the dropdown has been dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnAfterEnterEditModeOverridden. Fired after control enters edit mode.  
Protected MethodOnAfterExitEditModeCalled after edit mode has been exited. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnBeforeCheckStateChangedFires the BeforeCheckStateChanged event  
Protected MethodOnBeforeDropDownCalled before the dropdown has been dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnBeforeEnterEditModeCalled before edit mode has been entered. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnBeforeExitEditModeOverridden. Invoked before the CheckEditor exits edit mode.  
Protected MethodOnDisposeOverridden. Clean up any resources being used.  
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnOwnerKeyDownOccurs when the owner gets a key down while in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnOwnerKeyPressOccurs when the owner gets a key press while in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnOwnerKeyUpOverridden. Handles keyUp of owner  
Protected MethodOnSubObjectPropChangedOverridden. Invoked when a property has changed on a sub object  
Protected MethodOnValidateCheckStateFires the ValidateCheckState event  
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodUnhookOwnersKeyEventsUnhook from the owner's key events (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public Events
 NameDescription
Public EventAfterCheckStateChangedEvent to notify controls that checkstatus has changed  
Public EventAfterCloseUpOccurs after closing up the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterDropDownOccurs after dropping down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterEnterEditModeOccurs after entering edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterExitEditModeOccurs after exiting edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeCheckStateChangedEvent to notify controls that checkstatus has changed  
Public EventBeforeDropDownOccurs before dropping down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeEnterEditModeOccurs before entering edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeExitEditModeOccurs before exiting edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventKeyDownOccurs on a key down while the editor is in edit mode and the editor has focus. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventKeyPressOccurs on a key press while the editor is in edit mode and the editor has focus. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventKeyUpOccurs on a key up while the editor is in edit mode and the editor has focus. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventSelectionChangedOccurs when a new value is selected from the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Public EventValidateCheckStateFired before a change to the CheckState property is committed.  
Public EventValueChangedOccurs when the value is changed in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
See Also