Class FloorFilter

FloorFilter provides a browsing experience for floor-aware maps and scenes, and allows you to filter the view to show a single floor/level.

Inheritance

Object

FloorFilter

Implements

INotifyPropertyChanged

Namespace: Esri.ArcGISRuntime.Toolkit.UI.Controls

Assembly: Esri.ArcGISRuntime.Toolkit.WinUI.dll

Syntax

public class FloorFilter : Control, INotifyPropertyChanged

Constructors

| Improve this Doc View Source

FloorFilter()

Initializes a new instance of the FloorFilter class.

Declaration

public FloorFilter()

Fields

| Improve this Doc View Source

AllFacilitiesLabelProperty

Identifies the AllFacilitiesLabel dependency property.

Declaration

public static readonly DependencyProperty AllFacilitiesLabelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

AllFacilitiesProperty

Identiies the AllFacilities dependency property.

Declaration

public static readonly DependencyProperty AllFacilitiesProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

AllFloorsLabelProperty

Identifies the AllFloorsLabel dependency property.

Declaration

public static readonly DependencyProperty AllFloorsLabelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

AllSitesProperty

Identifies the AllSites dependency property.

Declaration

public static readonly DependencyProperty AllSitesProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

AutomaticSelectionModeProperty

Identifies the AutomaticSelectionMode dependency property.

Declaration

public static readonly DependencyProperty AutomaticSelectionModeProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

BackButtonLabelProperty

Identifies the BackButtonLabel dependency property.

Declaration

public static readonly DependencyProperty BackButtonLabelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

BrowseButtonStyleProperty

Identifies the BrowseButtonStyle dependency property.

Declaration

public static readonly DependencyProperty BrowseButtonStyleProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

BrowseFacilitiesLabelProperty

Identifies the BrowseFacilitiesLabel dependency property.

Declaration

public static readonly DependencyProperty BrowseFacilitiesLabelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

BrowseLabelProperty

Identifies the BrowseLabel dependency property.

Declaration

public static readonly DependencyProperty BrowseLabelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

BrowseSitesLabelProperty

Identifies the BrowseSitesLabel dependency property.

Declaration

public static readonly DependencyProperty BrowseSitesLabelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

CloseLabelProperty

Identifies the CloseLabel dependency property.

Declaration

public static readonly DependencyProperty CloseLabelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

CollapseLabelProperty

Identifies the CollapseLabel dependency property.

Declaration

public static readonly DependencyProperty CollapseLabelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

CommonListStyleProperty

Identifies the CommonListStyle dependency property.

Declaration

public static readonly DependencyProperty CommonListStyleProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

DifferentiatingFacilityDataTemplateProperty

Identifies the DifferentiatingFacilityDataTemplate dependency property.

Declaration

public static readonly DependencyProperty DifferentiatingFacilityDataTemplateProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

DisplayLevelsProperty

Identifies the DisplayLevels dependency property.

Declaration

public static readonly DependencyProperty DisplayLevelsProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

ExpandCollapseButtonStyleProperty

Identifies the ExpandCollapseButtonStyle dependency property.

Declaration

public static readonly DependencyProperty ExpandCollapseButtonStyleProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

ExpandLabelProperty

Identifies the ExpandLabel dependency property.

Declaration

public static readonly DependencyProperty ExpandLabelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

FacilityDataTemplateProperty

Identifies the FacilityDataTemplate dependency property.

Declaration

public static readonly DependencyProperty FacilityDataTemplateProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

GeoViewProperty

Identifies the GeoView dependency property.

Declaration

public static readonly DependencyProperty GeoViewProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

IsBrowseOpenProperty

Identifies the IsBrowseOpen dependency property.

Declaration

public static readonly DependencyProperty IsBrowseOpenProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

IsExpandedProperty

Identifies the "IsExpanded" attached property.

Declaration

public static readonly DependencyProperty IsExpandedProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

LevelDataTemplateProperty

Identifies the LevelDataTemplate dependency property.

Declaration

public static readonly DependencyProperty LevelDataTemplateProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

NoResultsMessageProperty

Identifies the NoResultsMessage dependency property.

Declaration

public static readonly DependencyProperty NoResultsMessageProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

SearchPlaceholderProperty

Identifies the SearchPlaceholder dependency property.

Declaration

public static readonly DependencyProperty SearchPlaceholderProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

SelectedFacilityProperty

Identifies the SelectedFacility dependency property.

Declaration

public static readonly DependencyProperty SelectedFacilityProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

SelectedLevelProperty

Identifies the SelectedLevel dependency property.

Declaration

public static readonly DependencyProperty SelectedLevelProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

SelectedSiteProperty

Identifies the SelectedSite dependency property.

Declaration

public static readonly DependencyProperty SelectedSiteProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

SiteDataTemplateProperty

Identifies the SiteDataTemplate dependency property.

Declaration

public static readonly DependencyProperty SiteDataTemplateProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

ZoomToButtonStyleProperty

Identifies the ZoomToButtonStyle dependency property.

Declaration

public static readonly DependencyProperty ZoomToButtonStyleProperty

Field Value

Type	Description
DependencyProperty

| Improve this Doc View Source

ZoomToLabelProperty

Identifies the ZoomToLabel dependency property.

Declaration

public static readonly DependencyProperty ZoomToLabelProperty

Field Value

Type	Description
DependencyProperty

Properties

| Improve this Doc View Source

AllDisplayLevelsSelected

Gets or sets a value indicating whether all of the levels for the selected facility should be enabled for display.

Declaration

public bool AllDisplayLevelsSelected { get; set; }

Property Value

Type	Description
Boolean

Remarks

This is used for showing an entire facility in 3D.

| Improve this Doc View Source

AllFacilities

Gets the list of all facilities in the floor-aware map or scene.

Declaration

public IList<FloorFacility>? AllFacilities { get; }

Property Value

Type	Description
Nullable<IList<FloorFacility>>

| Improve this Doc View Source

AllFacilitiesLabel

Gets or sets the label or tooltip shown for the button that is used to navigate to the list of sites in all facilities when the site browsing view is open.

Declaration

public string AllFacilitiesLabel { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

AllFloorsLabel

Gets or sets the label or tooltip shown for the button that shows all levels for a selected facility.

Declaration

public string AllFloorsLabel { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

AllSites

Gets the list of available sites.

Declaration

public IList<FloorSite>? AllSites { get; }

Property Value

Type	Description
Nullable<IList<FloorSite>>

| Improve this Doc View Source

AutomaticSelectionMode

Gets or sets the value that defines how the SelectedFacility is updated as the GeoView's viewpoint changes.

Declaration

public AutomaticSelectionMode AutomaticSelectionMode { get; set; }

Property Value

Type	Description
AutomaticSelectionMode

| Improve this Doc View Source

BackButtonLabel

Gets or sets the label or tooltip text shown on the back button used to navigate from the facilities to the site list when the browsing view is open.

Declaration

public string BackButtonLabel { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

BrowseButtonStyle

Gets or sets the style applied to the "Browse" button.

Declaration

public Style? BrowseButtonStyle { get; set; }

Property Value

Type	Description
Nullable<Style>

| Improve this Doc View Source

BrowseFacilitiesLabel

Gets or sets the label shown on the browsing view header for facilities.

Declaration

public string BrowseFacilitiesLabel { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

BrowseLabel

Gets or sets the label or tooltip shown on the button that opens the browsing view.

Declaration

public string BrowseLabel { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

BrowseSitesLabel

Gets or sets the label or tooltip shown on the browsing view header for sites.

Declaration

public string BrowseSitesLabel { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

CloseLabel

Gets or sets the label or tooltip shown for the button that is used to close the browsing view.

Declaration

public string CloseLabel { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

CollapseLabel

Gets or sets the label or tooltip shown on the expand/collapse button when the FloorFilter is expanded.

Declaration

public string CollapseLabel { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

CommonListStyle

Gets or sets the style applied to list views.

Declaration

public Style? CommonListStyle { get; set; }

Property Value

Type	Description
Nullable<Style>

| Improve this Doc View Source

DifferentiatingFacilityDataTemplate

Gets or sets the data template used to present items in the browsing view when facilities are being shown from multiple sites.

Declaration

public DataTemplate? DifferentiatingFacilityDataTemplate { get; set; }

Property Value

Type	Description
Nullable<DataTemplate>

| Improve this Doc View Source

DisplayLevels

Gets the list of levels in the currently-selected facility.

Declaration

public IList<FloorLevel>? DisplayLevels { get; }

Property Value

Type	Description
Nullable<IList<FloorLevel>>

| Improve this Doc View Source

ExpandCollapseButtonStyle

Gets or sets the style applied to the "Expand"/"Collapse" button.

Declaration

public Style? ExpandCollapseButtonStyle { get; set; }

Property Value

Type	Description
Nullable<Style>

| Improve this Doc View Source

ExpandLabel

Gets or sets the label or tooltip shown on the expand/collapse button when the FloorFilter is collapsed.

Declaration

public string ExpandLabel { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

FacilityDataTemplate

Gets or sets the template used to present items for a single site, or when there are no sites.

Declaration

public DataTemplate? FacilityDataTemplate { get; set; }

Property Value

Type	Description
Nullable<DataTemplate>

| Improve this Doc View Source

GeoView

Gets or sets the GeoView associated with this view.

Declaration

public GeoView? GeoView { get; set; }

Property Value

Type	Description
Nullable<GeoView>

| Improve this Doc View Source

IsBrowseOpen

Gets or sets a value indicating whether the browsing view is open.

Declaration

public bool IsBrowseOpen { get; set; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

LevelDataTemplate

Gets or sets the template used to present items.

Declaration

public DataTemplate? LevelDataTemplate { get; set; }

Property Value

Type	Description
Nullable<DataTemplate>

| Improve this Doc View Source

NoResultsMessage

Gets or sets the message shown to the user when a list or filtered list is empty.

Declaration

public string NoResultsMessage { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

SearchPlaceholder

Gets or sets the text shown as a placeholder in search/filter boxes in the browsing view.

Declaration

public string SearchPlaceholder { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

SelectedBrowseTab

Gets or sets the tab in the browsing experience that should be active.

Declaration

public int SelectedBrowseTab { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

SelectedFacility

Gets or sets the selected facility.

Declaration

public FloorFacility? SelectedFacility { get; set; }

Property Value

Type	Description
Nullable<FloorFacility>

| Improve this Doc View Source

SelectedLevel

Gets or sets the selected level.

Declaration

public FloorLevel? SelectedLevel { get; set; }

Property Value

Type	Description
Nullable<FloorLevel>

| Improve this Doc View Source

SelectedSite

Gets or sets the currently selected site.

Declaration

public FloorSite? SelectedSite { get; set; }

Property Value

Type	Description
Nullable<FloorSite>

| Improve this Doc View Source

ShowAllFloorsButton

Gets a value indicating whether the floor filter should display an 'All Floors' button.

Declaration

public bool ShowAllFloorsButton { get; }

Property Value

Type	Description
Boolean

Remarks

The 'All Floors' button is useful in 3D.

| Improve this Doc View Source

ShowFacilityBrowseLabel

Gets a value indicating whether the browse view should show BrowseFacilitiesLabel rather than BrowseSitesLabel.

Declaration

public bool ShowFacilityBrowseLabel { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

ShowSiteNameSubtitle

Gets a value indicating whether the selected site's name should be displayed in the browse experience.

Declaration

public bool ShowSiteNameSubtitle { get; }

Property Value

Type	Description
Boolean

Remarks

The site name label is redundant when browsing all sites and when on the site tab.

| Improve this Doc View Source

SiteDataTemplate

Gets or sets the data template used to present items in the browsing view.

Declaration

public DataTemplate? SiteDataTemplate { get; set; }

Property Value

Type	Description
Nullable<DataTemplate>

| Improve this Doc View Source

ZoomToButtonStyle

Gets or sets the style that is applied to the "Zoom To" button.

Declaration

public Style? ZoomToButtonStyle { get; set; }

Property Value

Type	Description
Nullable<Style>

| Improve this Doc View Source

ZoomToLabel

Gets or sets the label or tooltip shown on the button that zooms to the currently selected site or facility.

Declaration

public string ZoomToLabel { get; set; }

Property Value

Type	Description
String

Methods

| Improve this Doc View Source

GetIsExpanded(DependencyObject)

Gets a value indicating whether the given dependency object is in an expanded state.

Declaration

public static bool GetIsExpanded(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
Boolean

| Improve this Doc View Source

OnApplyTemplate()

Declaration

protected override void OnApplyTemplate()

| Improve this Doc View Source

SetIsExpanded(DependencyObject, Boolean)

Sets a value indicating whether the given dependency object is in an expanded state.

Declaration

public static void SetIsExpanded(DependencyObject obj, bool value)

Parameters

Type	Name	Description
DependencyObject	obj
Boolean	value

| Improve this Doc View Source

SetSelectedFacilityWithoutZoom(FloorFacility)

Sets the SelectedFacility without triggering a GeoView navigation.

Declaration

public void SetSelectedFacilityWithoutZoom(FloorFacility newSelection)

Parameters

Type	Name	Description
FloorFacility	newSelection

| Improve this Doc View Source

SetSelectedLevelWithoutZoom(FloorLevel)

Sets the SelectedLevel without triggering a GeoView navigation.

Declaration

public void SetSelectedLevelWithoutZoom(FloorLevel newLevel)

Parameters

Type	Name	Description
FloorLevel	newLevel

| Improve this Doc View Source

SetSelectedSiteWithoutZoom(FloorSite)

Sets the SelectedSite without triggering a GeoView navigation.

Declaration

public void SetSelectedSiteWithoutZoom(FloorSite newSelection)

Parameters

Type	Name	Description
FloorSite	newSelection

Events

| Improve this Doc View Source

PropertyChanged

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

Implements

INotifyPropertyChanged