FlipView Class

Summary

A control that imitate a slide show with back/forward buttons.
Namespace
MahApps.Metro.Controls
Base Types
  • Selector
graph BT Type-->Base0["Selector"] Type["FlipView"] class Type type-node

Syntax

[TemplatePart(Name = PART_Presenter, Type = typeof(TransitioningContentControl))]
[TemplatePart(Name = PART_BackButton, Type = typeof(Button))]
[TemplatePart(Name = PART_ForwardButton, Type = typeof(Button))]
[TemplatePart(Name = PART_UpButton, Type = typeof(Button))]
[TemplatePart(Name = PART_DownButton, Type = typeof(Button))]
[TemplatePart(Name = PART_BannerGrid, Type = typeof(Grid))]
[TemplatePart(Name = PART_BannerLabel, Type = typeof(Label))]
[TemplatePart(Name = PART_Index, Type = typeof(ListBox))]
[StyleTypedProperty(Property = nameof(NavigationButtonStyle), StyleTargetType = typeof(Button))]
[StyleTypedProperty(Property = nameof(IndexItemContainerStyle), StyleTargetType = typeof(ListBoxItem))]
public class FlipView : Selector

Attributes

Type Description
TemplatePart
TemplatePart
TemplatePart
TemplatePart
TemplatePart
TemplatePart
TemplatePart
TemplatePart
StyleTypedProperty
StyleTypedProperty

Constructors

Name Summary
FlipView()

Fields

Name Constant Value Summary
BannerBackgroundProperty
Identifies the BannerBackground dependency property.
static
BannerForegroundProperty
Identifies the BannerForeground dependency property.
static
BannerOpacityProperty
Identifies the BannerOpacity dependency property.
static
BannerTextProperty
Identifies the BannerText dependency property.
static
BannerTextStringFormatProperty
Identifies the BannerTextStringFormat dependency property.
static
BannerTextTemplateProperty
Identifies the BannerTextTemplate dependency property.
static
BannerTextTemplateSelectorProperty
Identifies the BannerTextTemplateSelector dependency property.
static
ButtonBackContentProperty
Identifies the ButtonBackContent dependency property.
static
ButtonBackContentStringFormatProperty
Identifies the ButtonBackContentStringFormat dependency property.
static
ButtonBackContentTemplateProperty
Identifies the ButtonBackContentTemplate dependency property.
static
ButtonDownContentProperty
Identifies the ButtonDownContent dependency property.
static
ButtonDownContentStringFormatProperty
Identifies the ButtonDownContentStringFormat dependency property.
static
ButtonDownContentTemplateProperty
Identifies the ButtonDownContentTemplate dependency property.
static
ButtonForwardContentProperty
Identifies the ButtonForwardContent dependency property.
static
ButtonForwardContentStringFormatProperty
Identifies the ButtonForwardContentStringFormat dependency property.
static
ButtonForwardContentTemplateProperty
Identifies the ButtonForwardContentTemplate dependency property.
static
ButtonUpContentProperty
Identifies the ButtonUpContent dependency property.
static
ButtonUpContentStringFormatProperty
Identifies the ButtonUpContentStringFormat dependency property.
static
ButtonUpContentTemplateProperty
Identifies the ButtonUpContentTemplate dependency property.
static
CircularNavigationProperty
Identifies the CircularNavigation dependency property.
static
DownTransitionProperty
Identifies the DownTransition dependency property.
static
IndexHorizontalAlignmentProperty
static
IndexItemContainerStyleProperty
Identifies the IndexItemContainerStyle dependency property.
static
IndexPlacementProperty
Identifies the IndexPlacement dependency property.
static
IndexVerticalAlignmentProperty
static
IsBannerEnabledProperty
Identifies the IsBannerEnabled dependency property.
static
IsNavigationEnabledProperty
Identifies the IsNavigationEnabled dependency property.
static
LeftTransitionProperty
Identifies the LeftTransition dependency property.
static
MouseHoverBorderBrushProperty
Identifies the MouseHoverBorderBrush dependency property.
static
MouseHoverBorderEnabledProperty
Identifies the MouseHoverBorderEnabled dependency property.
static
MouseHoverBorderThicknessProperty
Identifies the MouseHoverBorderThickness dependency property.
static
NavigationButtonsPositionProperty
Identifies the NavigationButtonsPosition dependency property.
static
NavigationButtonStyleProperty
Identifies the NavigationButtonStyle dependency property.
static
OrientationProperty
Identifies the Orientation dependency property.
static
RightTransitionProperty
Identifies the RightTransition dependency property.
static
ShowIndexProperty
Identifies the ShowIndex dependency property.
static
UpTransitionProperty
Identifies the UpTransition dependency property.
static

Properties

Name Value Summary
BannerBackground Brush
Gets or sets a System.Windows.Media.Brush that is used to fill the banner.
BannerForeground Brush
Gets or sets a System.Windows.Media.Brush that describes the foreground color of the banner label.
BannerOpacity double
Gets or sets the opacity factor applied to the entire banner when it is rendered in the user interface (UI).
BannerText object
Gets or sets the banner text.
BannerTextStringFormat string
Gets or sets a composite string that specifies how to format the BannerText property if it is displayed as a string.
BannerTextTemplate DataTemplate
Gets or sets the DataTemplate used to display the banner's content.
BannerTextTemplateSelector DataTemplateSelector
Gets or sets a template selector for BannerText property that enables an application writer to provide custom template-selection logic .
ButtonBackContent object
Provides the object content that should be displayed on the Back Button.
ButtonBackContentStringFormat string
Gets or sets a composite string that specifies how to format the ButtonBackContent property if it is displayed as a string.
ButtonBackContentTemplate DataTemplate
Gets or sets the DataTemplate used to display the Back button's content.
ButtonDownContent object
Provides the object content that should be displayed on the Down Button.
ButtonDownContentStringFormat string
Gets or sets a composite string that specifies how to format the ButtonDownContent property if it is displayed as a string.
ButtonDownContentTemplate DataTemplate
Gets or sets the DataTemplate used to display the Down button's content.
ButtonForwardContent object
Provides the object content that should be displayed on the Forward Button.
ButtonForwardContentStringFormat string
Gets or sets a composite string that specifies how to format the ButtonForwardContent property if it is displayed as a string.
ButtonForwardContentTemplate DataTemplate
Gets or sets the DataTemplate used to display the Forward button's content.
ButtonUpContent object
Provides the object content that should be displayed on the Up Button.
ButtonUpContentStringFormat string
Gets or sets a composite string that specifies how to format the ButtonUpContent property if it is displayed as a string.
ButtonUpContentTemplate DataTemplate
Gets or sets the DataTemplate used to display the Up button's content.
CircularNavigation bool
Gets or sets a value indicating whether the navigation is circular, so you get the first after last and the last before first.
DownTransition TransitionType
Gets or sets the transition of the down navigation.
IndexHorizontalAlignment HorizontalAlignment
Gets or sets the horizontal alignment characteristics applied to the navigation index.
IndexItemContainerStyle Style
Gets or sets a style for the navigation index items.
IndexPlacement NavigationIndexPlacement
Gets or sets a value specifying where the navigation index should be rendered.
IndexVerticalAlignment VerticalAlignment
Gets or sets the vertical alignment characteristics applied to the navigation index.
IsBannerEnabled bool
Gets or sets whether the banner is visible or not.
IsNavigationEnabled bool
Gets or sets whether the navigation button are visible or not.
LeftTransition TransitionType
Gets or sets the transition of the left navigation.
MouseHoverBorderBrush Brush
Gets or sets the border brush of the mouse hover effect.
MouseHoverBorderEnabled bool
Gets or sets a value indicating whether the border for mouse over effect is enabled or not.
MouseHoverBorderThickness Thickness
Gets or sets the border thickness for the border of the mouse hover effect.
NavigationButtonsPosition NavigationButtonsPosition
Gets or sets the position of the navigation buttons.
NavigationButtonStyle Style
Gets or sets the FrameworkElement.Style for the navigation buttons.
Orientation Orientation
Gets or sets the orientation of the navigation.
RightTransition TransitionType
Gets or sets the transition of the right navigation.
ShowIndex bool
Gets or sets a value indicating whether the navigation index should be visible.
UpTransition TransitionType
Gets or sets the transition of the up navigation.

Methods

Name Value Summary
GetContainerForItemOverride() DependencyObject
GoBack() void
Changes the current slide to the previous item.
GoForward() void
Changes the current to the next item.
HideControlButtons() void
Removes the control buttons (next/previous) from view.
IsItemItsOwnContainerOverride(object) bool
OnApplyTemplate() void
OnItemsChanged(Specialized.NotifyCollectionChangedEventArgs) void
OnKeyDown(KeyEventArgs) void
OnMouseDown(MouseButtonEventArgs) void
OnSelectionChanged(SelectionChangedEventArgs) void
PrepareContainerForItemOverride(DependencyObject, object) void
ShowControlButtons() void
Brings the control buttons (next/previous) into view.