The NavigationDataSource type exposes the following members.

Constructors

  NameDescription
NavigationDataSource
Initializes a new NavigationDataSource instance.

Methods

  NameDescription
AddedControl
Called after a child control is added to the Controls collection of the Control object.
(Inherited from Control.)
AddParsedSubObject
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
(Inherited from Control.)
ApplyStyleSheetSkin
Applies the style properties that are defined in the page style sheet to the control.
(Inherited from DataSourceControl.)
BuildProfileTree
Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
(Inherited from Control.)
ClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from Control.)
ClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control.)
ClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from Control.)
CopyCommand
Creates and returns a copy of the current command.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
CopyFrom
Copies values of properties from the specified command to the corresponding properties of this command.
CreateChildControls
Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
(Inherited from Control.)
CreateCommandView (Overrides EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>)..::.CreateCommandView()()().)
CreateControlCollection
Creates a collection to store child controls.
(Inherited from DataSourceControl.)
DataBindOverloaded.
DataBindChildren
Binds a data source to the server control's child controls.
(Inherited from Control.)
DeserializeCommand
Sets the command state based on the serialized value.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
Dispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from Control.)
EnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from Control.)
EnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from Control.)
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExpandMoreOverloaded.
Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
FindControlOverloaded.
Focus
Sets input focus to the control.
(Inherited from DataSourceControl.)
GetDesignModeState
Gets design-time data for a control.
(Inherited from Control.)
GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType
Gets the Type of the current instance.
(Inherited from Object.)
GetView (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
GetViewNames (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
HasControls
Determines if the server control contains any child controls.
(Inherited from DataSourceControl.)
HasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control.)
IsLiteralContent
Determines if the server control holds only literal content.
(Inherited from Control.)
LoadControlState
Restores control-state information from a previous page request that was saved by the SaveControlState()()() method.
(Inherited from Control.)
LoadExtendedUrlState
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
LoadViewState (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
MapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control.)
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control.)
OnCommandExecuted
Raises the CommandExecuted event.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
OnCommandPropertyChanged
Raises the CommandPropertyChanged event.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
OnCommandSelected
Raises the Selected event.
(Overrides EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>)..::.OnCommandSelected(Object, EndecaDataSourceSelectedEventArgs).)
OnCommandSelecting
Raises the Selecting event.
(Overrides EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>)..::.OnCommandSelecting(Object, EndecaCommandDataSourceSelectingEventArgs<(Of <(TCommand>)>)).)
OnDataBinding
Raises the DataBinding event.
(Inherited from Control.)
OnEngineExecuted
Raises the Executed()()() event.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
OnEngineExecuting
Raises the Executing()()() event.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
OnInit (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
OnLoad
Raises the Load event.
(Inherited from Control.)
OnPageLoadComplete
Force the select parameters to update themselves, so that data bound controls will re-bind themselves if any of the command parameters have changed.
(Overrides EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>)..::.OnPageLoadComplete(Object, EventArgs).)
OnPreRender
Raises the PreRender event.
(Inherited from Control.)
OnResolveView
Raises the ResolveView event.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
OnUnload
Raises the Unload event.
(Inherited from Control.)
OnViewSelected
Raises the ViewSelected event.
(Overrides EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>)..::.OnViewSelected(Object, ViewSelectedEventArgs).)
OnViewSelecting
Raises the ViewSelecting event.
(Overrides EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>)..::.OnViewSelecting(Object, ViewSelectingEventArgs).)
OpenFile
Gets a Stream used to read a file.
(Inherited from Control.)
RaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from Control.)
RaiseDataSourceChangedEvent
Raises the DataSourceChanged event.
(Inherited from DataSourceControl.)
RemovedControl
Called after a child control is removed from the Controls collection of the Control object.
(Inherited from Control.)
RemoveDimensionValueOverloaded.
Render
Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control.)
RenderChildren
Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control.)
RenderControlOverloaded.
ResetCommand
Resets the state of the command, effectively clearing out the data source.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
ResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from Control.)
ResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from Control.)
ResolveUrl
Converts a URL into one that is usable on the requesting client.
(Inherited from Control.)
SaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from Control.)
SaveExtendedUrlState
Called to give subclasses an opportunity to add additional state to a URL.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
SaveViewState (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
SelectOverloaded.
SelectDimensionValueOverloaded.
SelectParentDimensionValueOverloaded.
SerializeCommand
Returns the serialized command state.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
SetDesignModeState
Sets design-time data for a control.
(Inherited from Control.)
SetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from Control.)
ToggleDimensionStateExposureOverloaded.
ToString
Returns a String that represents the current Object.
(Inherited from Object.)
TrackViewState (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)

Fields

  NameDescription
NavigationResultView
The name of the data source view that provides access to the top level result returned by the navigation query. This view returns a collection containing a single NavigationResult instance.

Properties

  NameDescription
Adapter
Gets the browser-specific adapter for the control.
(Inherited from Control.)
AggregateRecordOffset
Gets or sets the offset within the results.
AggregateRecordsPerPage
Gets or sets the number of items in each result set.
AggregationKey
Gets or sets the property or dimension by which records should be aggregated
AlternativePhrasingMode
Gets or sets whether the search should use computed alternate phrasings for the search.
AnalyticsExpression
Gets or sets the analytics expression
AnalyticsExpressionParameters
Gets the collection of parameters used when this data source makes a query to the MDEX Engine.
AnalyticsSchema
Gets or sets the name and type of Analytics fields for each statement in data tables.
AppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.)
BindingContainer
Gets the control that contains this control's data binding.
(Inherited from Control.)
BusinessRulesFilter
Gets or sets the Filter for Business Rules.
BusinessRulesPreviewTime
Gets or sets the Preview Time for Business Rules.
ChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control.)
ClientID
Gets the server control identifier generated by ASP.NET.
(Inherited from DataSourceControl.)
ClientIDSeparator
Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control.)
Command
Returns the command object
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
Context
Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control.)
Controls
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from DataSourceControl.)
DesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.)
DimensionValueTypeName
Gets or sets the dimension value type
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
EnableDidYouMean
Gets or sets the "did you mean" option for the search.
EnableExposeAllRefinements
Gets or sets whether to return the children for all top-level refinements.
EnableRetrievePropertyData
Gets or sets whether the command should include key properties data in the results metadata. If not specified, the default value is false.
EnableTheming
Gets a value indicating whether this control supports themes.
(Inherited from DataSourceControl.)
EnableViewState
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from Control.)
EqlExpression
Gets or sets the Eql Expression.
Events
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control.)
HasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.)
ID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control.)
IdSeparator
Gets the character used to separate control identifiers.
(Inherited from Control.)
IncludedRecordAttributes
Gets the collection of RecordAttribute instances describing the dimension and properties to be retrieved when this data source makes a navigation query.
IsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.)
IsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control.)
IsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from Control.)
LanguageId
Gets or sets the language id for the command.
LoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control.)
MdexCertificatePath
Gets or sets the SSL certificate path.
(Inherited from BaseEndecaDataSource.)
MdexHostName
Gets or sets the host name of the machine against which queries will be performed.
(Inherited from BaseEndecaDataSource.)
MdexPort
Gets or sets the port number that the Mdex Engine is listening on.
(Inherited from BaseEndecaDataSource.)
NamespaceManager
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
NamingContainer
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
(Inherited from Control.)
Page
Gets a reference to the Page instance that contains the server control.
(Inherited from Control.)
Parent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control.)
PermanentRefinementConfigs
Gets a RefinementConfigCollection that describes the dimension values that remain exposed, regardless of user interaction.
RangeFilters
Gets the collection of RangeFilter instances describing range filters to be applied when this data source makes a navigation query.
RecordFilter
Gets or sets the record filter for the command.
RecordOffset
Gets or sets the offset within the results.
RecordsPerAggregateRecord
Gets or sets the number of constituent records to retrieve per aggregate record.
RecordsPerPage
Gets or sets the number of items in each result set.
RecordTypeName
Gets or sets the record type (Record or AggregateRecord)
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
RefinementConfigs
Gets the collection of DimensionValue IDs representing the refinements to be exposed when this data source makes a navigation query.
RelevanceRanking
Gets the Search object describing relevance ranking to be included when this data source makes a navigation query.
Searches
Gets the collection of Search instances describing search terms to be included when this data source makes a navigation query.
SelectedDimensionValueIds
Gets the collection of ids of all currently selected dimension values.
SelectParameters
Gets the collection of parameters used when this data source makes a query to the MDEX Engine.
Site
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.)
SkinID
Gets the skin to apply to the DataSourceControl control.
(Inherited from DataSourceControl.)
Sorts
Gets the collection of Sort instances describing sort keys to be included when this data source makes a navigation query.
StratifiedDimVals
Gets the collection of StratifiedDimConfig instances describing the dimension and properties to be retrieved when this data source makes a navigation query.
TemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from Control.)
TemplateSourceDirectory
Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control.)
UniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from Control.)
UserProfiles
Gets the collection of UserProfile instances that describe characteristics of an application end user.
ViewNames
See ViewNames.
(Overrides EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>)..::.ViewNames.)
ViewState
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from Control.)
ViewStateIgnoresCase
Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control.)
Visible
Gets or sets a value indicating whether the control is visually displayed.
(Inherited from DataSourceControl.)

Events

  NameDescription
CommandPropertyChanged
Raised when a property of the data source that affects the underlying EndecaCommand has changed.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
DataBinding
Occurs when the server control binds to a data source.
(Inherited from Control.)
Disposed
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from Control.)
EngineExecuted
Raised when the EndecaCommand encapsulated by this data source has queried the MDEX server using the Endeca Navigation API.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
EngineExecuting
Raised when the EndecaCommand encapsulated by this data source is about to query the MDEX server using the Endeca Navigation API.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
Init
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from Control.)
Load
Occurs when the server control is loaded into the Page object.
(Inherited from Control.)
PreRender
Occurs after the Control object is loaded but prior to rendering.
(Inherited from Control.)
ResolveView
Raised when the data source is queried with an unrecognized view name.
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
Selected
Raised immediately after the NavigationCommand encapsulated by this data source queries the MDEX engine.
Selecting
Raised immediately before the NavigationCommand encapsulated by this data source queries the MDEX engine.
Unload
Occurs when the server control is unloaded from memory.
(Inherited from Control.)
ViewSelected
Raised when one of the views of this data source has selected.
ViewSelecting
Raised when one of the views of this data source is selecting.

Explicit Interface Implementations

  NameDescription
IParserAccessor..::.AddParsedSubObject
For a description of this member, see AddParsedSubObject(Object).
(Inherited from Control.)
ICommandStateAccessor..::.Command
Returns the command object
(Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
ICommandSource..::.CommandExecuted (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
IListSource..::.ContainsListCollection
Indicates whether the data source control is associated with one or more lists of data.
(Inherited from DataSourceControl.)
IControlBuilderAccessor..::.ControlBuilder
For a description of this member, see ControlBuilder.
(Inherited from Control.)
IDataBindingsAccessor..::.DataBindings
For a description of this member, see DataBindings.
(Inherited from Control.)
IDataSource..::.DataSourceChanged
Occurs when a data source control has changed in a way that affects data-bound controls.
(Inherited from DataSourceControl.)
IExpressionsAccessor..::.Expressions
For a description of this member, see Expressions.
(Inherited from Control.)
ICommandSource<(Of <(TCommand>)>)..::.GetCommand (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
IControlDesignerAccessor..::.GetDesignModeState
For a description of this member, see GetDesignModeState()()().
(Inherited from Control.)
ICommandSource..::.GetEndecaCommand (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
IListSource..::.GetList
Gets a list of data source controls that can be used as sources of lists of data.
(Inherited from DataSourceControl.)
IDataSource..::.GetView
Gets the named DataSourceView object associated with the DataSourceControl control. Some data source controls support only one view, while others support more than one.
(Inherited from DataSourceControl.)
IDataSource..::.GetViewNames
Gets a collection of names, representing the list of DataSourceView objects associated with the DataSourceControl control.
(Inherited from DataSourceControl.)
IDataBindingsAccessor..::.HasDataBindings
For a description of this member, see HasDataBindings.
(Inherited from Control.)
IExpressionsAccessor..::.HasExpressions
For a description of this member, see HasExpressions.
(Inherited from Control.)
IUrlStateExtension..::.LoadExtendedState (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
IUrlStateExtension..::.SaveExtendedState (Inherited from EndecaCommandDataSource<(Of <(TCommand, TDataSource, TCommandView>)>).)
IControlDesignerAccessor..::.SetDesignModeState
For a description of this member, see SetDesignModeState(IDictionary).
(Inherited from Control.)
IControlDesignerAccessor..::.SetOwnerControl
For a description of this member, see SetOwnerControl(Control).
(Inherited from Control.)
IControlDesignerAccessor..::.UserData
For a description of this member, see UserData.
(Inherited from Control.)

See Also