Version

FormattedLinkEditor Class Members

The following tables list the members exposed by FormattedLinkEditor.

Public Constructors
 NameDescription
Public ConstructorFormattedLinkEditor ConstructorOverloaded.   
Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyBaseURLSpecifies the base url for relative links and image sources. This can be a file path or an internet url.  
Public Propertystatic (Shared in Visual Basic)BaseURLDefaultSpecifies the base url for relative links and image sources. This can be a file path or an internet url.  
Public PropertyButtonsLeftReturns of a collection of Infragistics.Win.UltraWinEditors.EditorButtonBase instances displayed on the left side of the editor. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public PropertyButtonsRightReturns of a collection of Infragistics.Win.UltraWinEditors.EditorButtonBase instances displayed on the right side of the editor. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public PropertyCanFocusOverridden. Overridden. Returns false since this editor never takes focus.  
Public PropertyContextMenuItemsSpecifies the menu items that should be displayed in the context menu when in edit mode.  
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 PropertyCurrentStateReturns bit flags that signify the current editing state of the control.  
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 PropertyEditInfoReturns an object that exposes edit related properties and methods. Instances of this class are valid only when the associated formatted text editor element is in edit mode.  
Public PropertyEditorSharedObjectNameSpecifies name of the shared object that was defined for this editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public Propertystatic (Shared in Visual Basic)EnableInPlaceIMEEditingGets or sets the value which indicates whether formatted text editors will allow in place IME editing.  
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. Overridden. Returns false since this editor never takes focus.  
Public PropertyHasButtonsLeftIndicates if there are any buttons in the collection. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public PropertyHasButtonsRightIndicates if there are any buttons in the collection. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public PropertyHideSelectionSpecifies whether to hide the selection when the control doesn't have focus. The default value of this property true.  
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 PropertyKeyActionMappingsGives you the ability to reconfigure the way the control responds to user keystrokes.  
Public PropertyScrollBarDisplayStyleSpecifies if and when to display the scrollbars. Default value is Never.  
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 PropertyShowTitleToolTipsSpecifies whether to show tool-tips specified in title attributes of the elements in formatted text values.  
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 PropertySupportsSelectableTextOverridden. Overridden. Returns true since this editor supports selecting contents.  
Public PropertySupportsSpellCheckingOverridden. Overridden. Returns true since this editor supports spell checking.  
Public PropertySupportsValueListSpecifies whether the editor supports value list (read-only). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTextLengthGets the length of the text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyTextSectionBreakModeSpecifies how words are broken up into text sections.  
Public PropertyTextSmoothingModeSpecifies whether to draw text antialiased. This property has effect only when drawing text using GDI+, which is the default text drawing mode.  
Public PropertyTreatValueAsSpecifies whether the values rendered by this editor will be raw text, URL's or formatted text. Default is Auto, which specifies that the values should be auto-detected.  
Public PropertyUnderlineLinksSpecifies when to underline the links.  
Public PropertyValueOverridden. The current value being edited.  
Public Propertystatic (Shared in Visual Basic)VisitedLinksReturns a static instance of VisitedLinksCollection that the link editor uses as the default visited links manager. This property is read-only.  
Public PropertyVisitedLinksManagerSpecifies the visited links manager for managing visited links. Default value returned by this property is a static instance shared among all the link editors.  
Protected Properties
 NameDescription
Protected PropertyHasOwnDefaultContextMenuOverridden. Indicates that this editor has its own default ContextMenu, so a ContextMenu from an ancestor control is ignored  
Protected PropertySelectedTextInternalOverridden. Overridden. Gets or sets the currently selected text in the editor.  
Protected PropertySelectionLengthInternalOverridden. Overridden. Gets or sets the number of characters selected in the editor.  
Protected PropertySelectionStartInternalOverridden. Overridden. Gets or sets the starting point of text selected in the editor.  
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Protected PropertyTextLengthInternalOverridden. Overridden. Gets the length of the text in the editor.  
Protected PropertyWantsOwnerKeyEventsSpecifies whether the editor wants to receive key events from the owner while in edit mode (read-only). (Inherited from Infragistics.Win.EmbeddableEditorBase)
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. Determines if the type can be edited.  
Public MethodCanRenderTypeOverridden. Determines if the type can be rendered.  
Public MethodCloneOverridden. Creates a copy of the embeddable editor with the specified default owner.  
Public MethodCloseUpCalled to have the dropdown close up. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodComparesByValueOverridden. Returns whether the owner should compare items based on their underlying value rather than their display text.  
Public MethodCreateAccessibilityInstanceOverridden. Used by an editor owner to create an accessible object for a specific object managed by an editor.  
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 MethodCreateUIAutomationProviderOverridden. Creates the UI automation provider.  
Public MethodDataValueToTextOverloaded. Overridden. Converts data value to text making use of any format provider and format strings that owner may provide. If unsuccessful, returns null.  
Public Methodstatic (Shared in Visual Basic)DecodeImageDecodes the specified image data that was encoded using EncodeImage into an image.  
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodDropDownCalled to drop down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public Methodstatic (Shared in Visual Basic)EncodeImageEncodes the specified image into a string that can be embedded inside the formatted text. The returned value can be assigned to the 'data' attribute of the 'img' tag to embedd the image directly inside the formatted text value.  
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. Overridden. Always returns false since this editor never takes focus.  
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. Overridden. Called from inside the Infragistics.Win.UIElement.PositionChildElements method of the parent element to create and position the embedded element or elements.  
Public MethodGetEmbeddableElementTypeOverridden. Returns the type of the EmbeddableUIElementBase derived class that this editor uses as it's embeddable element.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetMinimumTouchFriendlyHeightReturns the minimum height needed to display in touch-friendly mode. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public MethodGetSizeOverloaded. Overridden. Used to determine the size preferred/required by the editor.  
Public MethodGetSpellCheckTargetOverridden. Overridden. Returns the spell checker target.  
Public MethodGetTextReturns the text.  
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 MethodPerformActionSimulates user interaction with the control.  
Public MethodResetButtonsLeftUsed to reset the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.ButtonsLeft collection (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public MethodResetButtonsRightUsed to reset the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.ButtonsRight collection (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public MethodSelectAllSelects all text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
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 MethodGetAutoConvertedDestinationValueOverride this in specific editor to provide automatic conversions for that editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetDisplayValueOverridden. Override this in specific editor to provide display value.  
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 MethodHasAnySpinButtonsReturns true if the editor displays any spin buttons. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodHookOwnersKeyEventsStart listening to the owner's key events (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodInitializeFromOverridden. Overridden.  
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 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 MethodOnAfterEditorButtonCheckStateChangedUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.AfterEditorButtonCheckStateChanged event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnAfterEditorButtonCloseUpUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.AfterEditorButtonCloseUp event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnAfterEnterEditModeOverridden. Called after edit mode has been entered.  
Protected MethodOnAfterExitEditModeOverridden. Called after edit mode has been exited.  
Protected MethodOnBeforeDropDownCalled before the dropdown has been dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnBeforeEditorButtonCheckStateChangedUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.BeforeEditorButtonCheckStateChanged event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnBeforeEditorButtonDropDownUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.BeforeEditorButtonDropDown event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnBeforeEnterEditModeCalled before edit mode has been entered. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnBeforeExitEditModeCalled before edit mode has been exited. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnDisposeOverridden. Called when the editor is disposed  
Protected MethodOnEditorButtonClickUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.EditorButtonClick event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnEditorSpinButtonClickUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.EditorSpinButtonClick event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnInitializeEditorButtonCheckStateUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.InitializeEditorButtonCheckState event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnOwnerKeyDownOverridden. Occurs when the owner gets a key down while in edit mode.  
Protected MethodOnOwnerKeyPressOverridden. Occurs when the owner gets a key press while in edit mode.  
Protected MethodOnOwnerKeyUpOverridden. Occurs when the owner gets a key up while in edit mode.  
Protected MethodOnSubObjectPropChangedInvoked when a property on a subobject has changed. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodShouldSerializeButtonsLeftIndicates if the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.ButtonsLeft property should be serialized (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodShouldSerializeButtonsRightIndicates if the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.ButtonsRight property should be serialized (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodUnhookOwnersKeyEventsUnhook from the owner's key events (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public Events
 NameDescription
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 EventAfterEditorButtonCheckStateChangedInvoked after the Infragistics.Win.UltraWinEditors.StateEditorButton.CheckState has changed. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventAfterEditorButtonCloseUpInvoked when a dropdown editor button has closed. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventAfterEnterEditModeOccurs after entering edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterExitEditModeOccurs after exiting edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeDropDownOccurs before dropping down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeEditorButtonCheckStateChangedInvoked before the Infragistics.Win.UltraWinEditors.StateEditorButton.CheckState has changed. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventBeforeEditorButtonDropDownInvoked before a dropdown editor button has been displayed. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventBeforeEnterEditModeOccurs before entering edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeExitEditModeOccurs before exiting edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventEditorButtonAddedInvoked when an editor button is added to the collection (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventEditorButtonClickInvoked when an editor button is clicked (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventEditorSpinButtonClickInvoked when an spin editor button is clicked (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventEditStateChangedFired when state of the editor changes. for example when the SelectionStart or SelectionLength changes or undo/redo history changes etc...  
Public EventInitializeEditorButtonCheckStateInvoked when the checkstate of an editor button should be initialized. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
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 EventLinkClickedOccurs when the user clicks a link.  
Public EventParseErrorFired when an error occurs parsing the value. This occurs when the formatted link editor encounters an invalid value.  
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 EventValueChangedOccurs when the value is changed in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
See Also