The NavigationCommand type exposes the following members.

Constructors

  NameDescription
NavigationCommandOverloaded.

Methods

  NameDescription
AddOrReplaceParameter
Adds the parameter to the EndecaParameterCollection and replaces an existing parameter if one is present
(Inherited from EndecaCommand.)
CopyFrom
Copies values of properties from the specified command to the corresponding properties of this command.
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Execute
Executes the command and returns the composite result.
ExpandMoreOverloaded.
Fill
Executes this command and assigns the raw engine results to the specified result object. Note that the engine results are not marshalled into RAD output type until specifically requested by a consumer accessing result.
(Inherited from EndecaCommand.)
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.)
GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
GetParameterValue
Gets the value of the parameter with the specified name, or null if there is no such parameter.
(Inherited from EndecaCommand.)
GetType
Gets the Type of the current instance.
(Inherited from Object.)
IsAggregateRecordsPerPageSet
This method allows external code to determine whether AggregateRecordsPerPage has been set. This is necessary because simply accessing AggregateRecordsPerPage will fall back to the default if it has not been set.
IsEmptyCommand (Overrides EndecaCommand..::.IsEmptyCommand()()().)
IsRecordsPerPageSet
This method allows external code to determine whether RecordsPerPage has been set. This is necessary because simply accessing RecordsPerPage will fall back to the default if it has not been set.
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnCommandExecuted
Raises the CommandExecuted event.
(Inherited from EndecaCommand.)
OnExecuted
Raises the EngineExecuted event.
(Inherited from EndecaCommand.)
OnExecuting
Raises the EngineExecuting event.
(Inherited from EndecaCommand.)
OnParametersChanged
Raises the ParametersChanged event.
(Inherited from EndecaCommand.)
RemoveDimensionValueOverloaded.
ResetParameters
Clears out collection parameters and nulls scalar parameters.
(Inherited from EndecaCommand.)
SelectDimensionValueOverloaded.
SelectParentDimensionValueOverloaded.
ToggleDimensionStateExposureOverloaded.
ToString
Returns a String that represents the current Object.
(Inherited from Object.)

Properties

  NameDescription
AggregateRecordOffset
Gets or sets the offset within the results.
AggregateRecordsPerPage
Gets or sets the number of aggregate records in each result set. The default is set to 10 to be compatible with the pager control. The returned results does not provide the number of items per page (Note, # of items per page is different than the number of results returned in the case there are less matching results than # of requested items per page). Thus, the result must obtain the # of items per page from the command.
AggregationKey
Gets or sets the property or dimension by which records should be aggregated.
AlternativePhrasingMode
Gets or sets whether alternate phrasing computation should be performed on the search.
AnalyticsExpression
Gets or sets the AnalyticsExpression used in the command. Using the Analytics property will overwrite this property.
AnalyticsParameters
Gets the EndecaParameterCollection of parameters to be used in a parameterized AnalyticsExpression.
AnalyticsSchema
Gets the DataSet which specifies the name and type of Analytics fields for each statement in data tables.
BusinessRulesFilter
Gets or sets the filter used to evaluate the firing of Rules in the Mdex engine.
BusinessRulesPreviewTime
Gets or sets the preview time used to evaluate the firing of Rules in the Mdex engine.
Connection
Gets or sets the connection to the MDEX Engine.
(Inherited from EndecaCommand.)
EnableDidYouMean
Gets or sets the "did you mean" option for the search.
EnableExposeAllRefinements
Get or sets the option 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. Defaults to false.
EqlExpression
Gets or sets the EQL expression for the command.
ID
Gets or sets the command identifier
(Inherited from EndecaCommand.)
IncludedRecordAttributes
The collection of dimensions and properties which should be returned with the results.
LanguageId
Gets or sets the LanguageId for the command.
RangeFilters
Gets the collection of range filters for the command.
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 records in each result set. The default is set to 10 to be compatible with the pager control. The returned results does not provide the number of items per page (Note, # of items per page is different than the number of results returned in the case there are less matching results than # of requested items per page). Thus, the result must obtain the # of items per page from the command.
RefinementConfigs
The collection of refinements whose children should be returned in the results.
RelevanceRanking
Gets or sets the strategy used for relevance ranking records.
Searches
Gets the collection of record searches for the command
SelectedDimensionValueIds
Gets the collection of ids of all currently selected dimension values.
Sorts
Gets the collection of sorts specified for the command.
StratifiedDimVals
Gets or sets the LanguageId for the command.
TypeNames
Gets or sets a TypeNames object that contains the names of the types that represent Endeca primitives (i.e. records and dimension values).
(Inherited from EndecaCommand.)
UserProfiles
Gets or sets the profiles that describe characteristics of an application end user.

Events

  NameDescription
CommandExecuted
Raised when this command has queried the MDEX engine the results have been marshaled into the RAD API objects.
(Inherited from EndecaCommand.)
EngineExecuted
Raised when this command has queried the MDEX engine, and results are available.
(Inherited from EndecaCommand.)
EngineExecuting
Raises when this command is about to query the MDEX engine.
(Inherited from EndecaCommand.)
ParametersChanged
Raised when the value of a property of this command that affects the query made to the MDEX engine has changed.
(Inherited from EndecaCommand.)

Explicit Interface Implementations

See Also