The Breadcrumbs type exposes the following members.

Constructors

  NameDescription
Breadcrumbs
Instantiates a new Breadcrumbs

Methods

  NameDescription
AddAttributesToRender
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from WebControl.)
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.)
ApplyStyle
Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from WebControl.)
ApplyStyleSheetSkin
Applies the style properties defined in the page style sheet to the control.
(Inherited from Control.)
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.)
ConfirmInitState
Sets the initialized state of the data-bound control.
(Inherited from BaseDataBoundControl.)
CopyBaseAttributes
Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from WebControl.)
CreateChildControlsOverloaded.
CreateControlCollection
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from Control.)
CreateControlStyle
Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.
(Inherited from WebControl.)
CreateDataSourceSelectArguments
Creates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified.
(Inherited from DataBoundControl.)
DataBindOverloaded.
DataBindChildren
Binds a data source to the server control's child controls.
(Inherited from Control.)
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.)
EnsureDataBound
Calls the DataBind()()() method if the DataSourceID property is set and the data-bound control is marked to require binding.
(Inherited from BaseDataBoundControl.)
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.)
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 a control.
(Inherited from Control.)
GetData
Retrieves a DataSourceView object that the data-bound control uses to perform data operations.
(Inherited from DataBoundControl.)
GetDataSource
Retrieves the IDataSource interface that the data-bound control is associated with, if any.
(Inherited from DataBoundControl.)
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.)
HasControls
Determines if the server control contains any child controls.
(Inherited from Control.)
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 (Overrides Control..::.LoadControlState(Object).)
LoadViewState
Restores view-state information from a previous request that was saved with the SaveViewState()()() method.
(Inherited from WebControl.)
MapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control.)
MarkAsDataBound
Sets the state of the control in view state as successfully bound to data.
(Inherited from DataBoundControl.)
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
MergeStyle
Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from WebControl.)
OnApplySearchAdjustment
Used when a ApplyAdjustment is issued
OnBubbleEvent (Overrides Control..::.OnBubbleEvent(Object, EventArgs).)
OnBuildingUrl
Raises the BuildingUrl event.
OnDataBinding
Raises the DataBinding event.
(Inherited from Control.)
OnDataBound
Raises the DataBound event.
(Inherited from BaseDataBoundControl.)
OnDataPropertyChanged
Rebinds the data-bound control to its data after one of the base data source identification properties changes.
(Inherited from DataBoundControl.)
OnDataSourceViewChanged
Raises the DataSourceViewChanged event.
(Inherited from DataBoundControl.)
OnDimensionValueItemCreated
Raises the DimensionValueItemCreated event.
OnDimensionValueItemDataBound
Raises the DimensionValueItemDataBound event.
OnInit
Uses the Init lifecycle event to register this control to use ControlState
(Overrides BaseDataBoundControl..::.OnInit(EventArgs).)
OnItemCommand
Raises this ItemCommand event.
OnLoad
Handles the Load event.
(Inherited from DataBoundControl.)
OnPagePreLoad
Sets the initialized state of the data-bound control before the control is loaded.
(Inherited from DataBoundControl.)
OnPreRender
Handles the PreRender event.
(Inherited from BaseDataBoundControl.)
OnRangeFilterItemCreated
Raises the RangeFilterItemCreated event.
OnRangeFilterItemDataBound
Raises the RangeFilterItemDataBound event.
OnRemoveDimensionValue
Used when a RemoveDimensionValueCommand is issued
OnRemoveRangeFilter
Used when a RemoveRangeFilterCommand is issued
OnRemoveSearch
Used when a RemoveSearchCommand is issued
OnSearchAdjustmentItemCreated
Raises the SearchAdjustmentItemCreated event.
OnSearchAdjustmentItemDataBound
Raises the SearchAdjustmentItemDataBound event.
OnSearchReportItemCreated
Raises the SearchReportItemCreated event.
OnSearchReportItemDataBound
Raises the SearchReportItemDataBound event.
OnSelectDimensionValue
Used when a SelectDimensionValueCommand is issued
OnSelectParentDimensionValue
Used when a SelectParentDimensionValueCommand is issued
OnUnload
Raises the Unload event.
(Inherited from Control.)
OpenFile
Gets a Stream used to read a file.
(Inherited from Control.)
PerformDataBinding
Binds the data from the data source to the composite data-bound control.
(Inherited from CompositeDataBoundControl.)
PerformSelect
Retrieves data from the associated data source.
(Inherited from DataBoundControl.)
RaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from Control.)
RemovedControl
Called after a child control is removed from the Controls collection of the Control object.
(Inherited from Control.)
Render
Renders the control to the specified HTML writer.
(Inherited from WebControl.)
RenderBeginTag
Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl.)
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.)
RenderContents
Renders the contents of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl.)
RenderControlOverloaded.
RenderEndTag
Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
(Inherited from WebControl.)
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 (Overrides Control..::.SaveControlState()()().)
SaveViewState
Saves any state that was modified after the TrackViewState()()() method was invoked.
(Inherited from WebControl.)
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.)
ToString
Returns a String that represents the current Object.
(Inherited from Object.)
TrackViewState
Causes the control to track changes to its view state so they can be stored in the object's ViewState property.
(Inherited from WebControl.)
ValidateDataSource
Verifies that the object a data-bound control binds to is one it can work with.
(Inherited from DataBoundControl.)

Fields

  NameDescription
ApplyAdjustment
Name of the command that indicates that a "Did You Mean" term should be applied.
RemoveDimensionValueCommand
Name of the command that indicates that an entire dimension breadcrumb should be removed.
RemoveRangeFilterCommand
Name of the command that indicates that a range filter breadcrumb should be removed.
RemoveSearchCommand
Name of the command that indicates that a search breadcrumb should be removed.
SelectDimensionValueCommand
Name of the command that indicates that the navigation state should be changed to include the dimension value supplied.
SelectParentDimensionValueCommand
Name of the command that indicates that the navigation state should be changed to include the parent of the dimension value supplied.

Properties

  NameDescription
AccessKey
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl.)
Adapter
Gets the browser-specific adapter for the control.
(Inherited from Control.)
AppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.)
Attributes
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from WebControl.)
BackColor
Gets or sets the background color of the Web server control.
(Inherited from WebControl.)
BindingContainer
Gets the control that contains this control's data binding.
(Inherited from Control.)
BorderColor
Gets or sets the border color of the Web control.
(Inherited from WebControl.)
BorderStyle
Gets or sets the border style of the Web server control.
(Inherited from WebControl.)
BorderWidth
Gets or sets the border width of the Web server control.
(Inherited from WebControl.)
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 Control.)
ClientIDSeparator
Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control.)
Context
Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control.)
Controls
Gets a collection of the child controls within the composite data-bound control.
(Inherited from CompositeDataBoundControl.)
ControlStyle
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from WebControl.)
ControlStyleCreated
Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
(Inherited from WebControl.)
CssClass
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from WebControl.)
DataMember
See DataMember. This control only suppors AppliedFiltersResult data.
(Overrides DataBoundControl..::.DataMember.)
DataSource
Gets or sets the object from which the data-bound control retrieves its list of data items.
(Inherited from BaseDataBoundControl.)
DataSourceID
Gets or sets the ID of the control from which the data-bound control retrieves its list of data items.
(Inherited from DataBoundControl.)
DataSourceObject (Inherited from DataBoundControl.)
DesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.)
Enabled
Gets or sets a value indicating whether the Web server control is enabled.
(Inherited from WebControl.)
EnableTheming
Gets or sets a value indicating whether themes apply to this control.
(Inherited from WebControl.)
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.)
Events
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control.)
ExclusionDimensionIds
Gets a collection of IDs of the DimensionStates that should be not displayed by this control.
FirstDimensionValueTemplate
Gets or sets a template that defines the display of the first or root dimension value in each dimension breadcrumb
Font
Gets the font properties associated with the Web server control.
(Inherited from WebControl.)
ForeColor
Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from WebControl.)
HasAttributes
Gets a value indicating whether the control has attributes set.
(Inherited from WebControl.)
HasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.)
Height
Gets or sets the height of the Web server control.
(Inherited from WebControl.)
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.)
InclusionDimensionIds
Gets a collection of IDs of the DimensionStates that should be displayed by this control.
Initialized
Gets a value indicating whether the data-bound control has been initialized.
(Inherited from BaseDataBoundControl.)
IntermediateDimensionValueTemplate
Gets or sets a template that defines the display of the intermediate dimension values in each dimension breadcrumb.
IsBoundUsingDataSourceID
Gets a value indicating whether the DataSourceID property is set.
(Inherited from BaseDataBoundControl.)
IsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.)
IsEnabled
Gets a value indicating whether the control is enabled.
(Inherited from WebControl.)
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.)
LastDimensionValueTemplate
Gets or sets a template that defines the display of the last or descriptor dimension value in each dimension breadcrumb
LoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control.)
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.)
NavigationDataSourceID
The NavigationDataSource to use for any command changes that would be done by the user. This propery should only be used in conjunction with the DataSource property. This property should not be used in conjunction the DataSourceID property.
(Inherited from EndecaCompositeDataBoundControl.)
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.)
RangeBreadcrumbTemplate
Gets or sets a template that defines how RangeFilter items are displayed.
RemoveImageUrl
Gets or sets the image this control will display as a remove link when using alternate rendering and instead of the remove button when using standard rendering
RemoveLinkText
Gets or sets the text this control will display as a remove link when useing alternate rendering
RenderHyperlinks
Returns true iff UrlManager is active.
(Inherited from EndecaCompositeDataBoundControl.)
RequiresDataBinding
Gets or sets a value indicating whether the DataBind()()() method should be called.
(Inherited from BaseDataBoundControl.)
SearchBreadcrumbTemplate
Gets or sets a template that defines how SearchReport items are displayed.
SelectArguments
Gets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control.
(Inherited from DataBoundControl.)
Separator
The separator to use between elements of the dimensions template.
ShowFullyInertSelectedDimensionValues
Whether the control should show inert dimensions as breadcrumbs.
ShowPartiallyInertSelectedDimensionValues
Whether the control should show inert dimension values within breadcrumbs.
ShowRangeFilters
Whether the control should show range breadcrumbs.
ShowSearches
Whether the control should show search breadcrumbs.
ShowSelectedDimensionValues
Whether the control should show dimension breadcrumbs.
Site
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.)
SkinID
Gets or sets the skin to apply to the control.
(Inherited from WebControl.)
Style
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from WebControl.)
SuggestedSearchAdjustmentCaption
The caption used for suggested search adjustments (Did you mean).
SuggestedSearchAdjustmentTemplate
Gets or sets a template that defines how suggested SearchAdjustment items are displayed. This template is used for Did you Mean terms.
TabIndex
Gets or sets the tab index of the Web server control.
(Inherited from WebControl.)
TagKey
See TagKey.
(Overrides WebControl..::.TagKey.)
TagName
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from WebControl.)
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.)
Title
Gets or sets the title to be displayed by the control when there are breadcrumbs.
TitleWhenEmpty
The title to be displayed when there are no breadcrumbs.
ToolTip
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from WebControl.)
UniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from Control.)
UrlManager
Returns the UrlManager with the specified UrlManagerId, or null
(Inherited from EndecaCompositeDataBoundControl.)
UrlManagerId
Gets or sets a value indicating which UrlManager to use. The Default UrlManager will be used if no value is provided.
(Inherited from EndecaCompositeDataBoundControl.)
UseAlternateRendering
Gets or sets whether this control will display breadcrumbs with remove links instead of select links"
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 that indicates whether a server control is rendered as UI on the page.
(Inherited from Control.)
Width
Gets or sets the width of the Web server control.
(Inherited from WebControl.)

Events

  NameDescription
BuildingUrl
Raised when the control is building a URL
DataBinding
Occurs when the server control binds to a data source.
(Inherited from Control.)
DataBound
Occurs after the server control binds to a data source.
(Inherited from BaseDataBoundControl.)
DimensionValueItemCreated
Raised after a BreadcrumbsDimensionValueItem is first created in the Breadcrumbs control, and before it is data bound.
DimensionValueItemDataBound
Raised after a DimensionValue is data bound in the Breadcrumbs control, and before it is rendered on the page.
DimensionValueParentSelected
Raised when the user selects a dimension value's parent.
DimensionValueRemoved
Raised when the user removes a dimension value.
DimensionValueSelected
Raised when the user selects a dimension value.
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.)
Init
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from Control.)
ItemCommand
Raised when a button is clicked in the Breadcrumbs 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.)
RangeFilterItemCreated
Raised after a BreadcrumbsRangeFilterItem is first created in the Breadcrumbs control, and before it is data bound.
RangeFilterItemDataBound
Raised after a RangeFilter is data bound in the Breadcrumbs control, and before it is rendered on the page.
RangeFilterRemoved
Raised when the user removes an applied range filter
SearchAdjustmentApplied
Raised when the user applies a suggested search adjustment.
SearchAdjustmentItemCreated
Raised after a BreadcrumbsSearchAdjustmentItem is first created in the Breadcrumbs control, and before it is data bound.
SearchAdjustmentItemDataBound
Raised after a SearchAdjustment is data bound in the Breadcrumbs control, and before it is rendered on the page.
SearchRemoved
Raised when the user removes an applied search.
SearchReportItemCreated
Raised after a BreadcrumbsSearchReportItem is first created in the Breadcrumbs control, and before it is data bound.
SearchReportItemDataBound
Raised after a SearchReport is data bound in the Breadcrumbs control, and before it is rendered on the page.
Unload
Occurs when the server control is unloaded from memory.
(Inherited from Control.)

Explicit Interface Implementations

  NameDescription
IParserAccessor..::.AddParsedSubObject
For a description of this member, see AddParsedSubObject(Object).
(Inherited from Control.)
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.)
IExpressionsAccessor..::.Expressions
For a description of this member, see Expressions.
(Inherited from Control.)
IAttributeAccessor..::.GetAttribute
Gets an attribute of the Web control with the specified name.
(Inherited from WebControl.)
IControlDesignerAccessor..::.GetDesignModeState
For a description of this member, see GetDesignModeState()()().
(Inherited from Control.)
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.)
IAttributeAccessor..::.SetAttribute
Sets an attribute of the Web control to the specified name and value.
(Inherited from WebControl.)
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