Skip to end of metadata
Go to start of metadata

LinkSettings class provides information about WebCombo links configurations.

Definition

public sealed class LinkSettings : WebUIBaseClass

Summary

The following table summarizes the members exposed in this class.

Public Constructors

LinkSettings Constructor() Initializes a new instance of the LinkSettings class with no argument.
LinkSettings Constructor(SerializationInfo, StreamingContext) Initializes a new instance of the LinkSettings class with SerializationInfo and StreamingContext.

Public Properties

Enabled Gets or sets whether the link feature should be enabled for this WebCombo instance.
FilterDataMember Gets or sets the data member within the DataSource which should be used for filtering during automatic lookup.
FilterMemberDataType Gets or sets the data type of the specified filter data member. This property is required when the BindingOperation is set to Client.
ParentEmptyAction Gets or sets the action to be performed when the user requests data for this WebCombo instance, but the specified ParentWebCombo(s) are still empty (no value selected).
ParentFilterMode Gets or sets which key field of the parent WebCombo that should be used for filtering this WebCombo data.
ParentWebComboID Gets or sets the parent WebCombo's ID which this instance should be linked to.
ResolvedParentWebComboID This property is not intended to be called directly by developers.
SkipQueryTextField Gets or sets a value indicating whether WebCombo should query the text based on the DataTextField.

Public Methods


Public Constructors

public LinkSettings()

Initializes a new instance of the LinkSettings class with no argument.

public LinkSettings(SerializationInfo info, StreamingContext context)

Initializes a new instance of the LinkSettings class with SerializationInfo and StreamingContext.

Parameters

info
context

Public Properties

public bool Enabled { get; set; }

Gets or sets whether the link feature should be enabled for this WebCombo instance.

public string FilterDataMember { get; set; }

Gets or sets the data member within the DataSource which should be used for filtering during automatic lookup.

Remarks

You may leave this property blank to use the same field specified in parent's WebCombo value or text field. If you need to link to multiple parent WebCombo, you can leave this property blank or specify multiple filter members separated by comma, in the appropriate order of ParentWebComboID property.

public string FilterMemberDataType { get; set; }

Gets or sets the data type of the specified filter data member. This property is required when the BindingOperation is set to Client.

public EmptyAction ParentEmptyAction { get; set; }

Gets or sets the action to be performed when the user requests data for this WebCombo instance, but the specified ParentWebCombo(s) are still empty (no value selected).

Remarks

By default, the value of this property is PromptMessage where the combo will prompt a message if the ParentWebCombo contains no value. If you set this property to ShowEmptyResult, the combo will show empty result when the ParentWebCombo contains no value.

public ParentFilterMode ParentFilterMode { get; set; }

Gets or sets which key field of the parent WebCombo that should be used for filtering this WebCombo data.

public string ParentWebComboID { get; set; }

Gets or sets the parent WebCombo's ID which this instance should be linked to.

public string ResolvedParentWebComboID { get; }

This property is not intended to be called directly by developers.

public bool SkipQueryTextField { get; set; }

Gets or sets a value indicating whether WebCombo should query the text based on the DataTextField.

Remarks

You can set this property to True when you don't want the WebCombo to be filtered by the entered text. This is especially useful when the DataTextField is not a String type, where WebCombo can't effectively perform automatic lookup. In this scenario, oftenly the WebCombo is ReadOnly (not Editable) and user simply pick a selection from the ResultBox.

Public Methods

public void GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

info
context
  • No labels