WPFCustomControls::MaxRibbonControl Class Reference

---

Detailed Description

<exclude>

List of all members.

Public Types
enum	SubobjectModeEnum {   Undefined = -1, Object = 0, Vertex, Edge,   Border, Polygon, Element }
Public Member Functions
	MaxRibbonControl ()
void	UpdateRibbonItemToolTip (RibbonItem item)
	Look up a new ToolTip for the given RibbonItem, overwriting any current ToolTip.
void	RaiseActionItemButtonRefreshEvent ()
void	ClearPanelDirtyFlags ()
void	Save (string configPath)
ICollection < MaxModelingRibbonPanel >	FindActionItemPanel (int index)
	Returns a collection of MaxModelingRibbonPanels panels that have a matching ActionItemIndex.
Static Public Attributes
static readonly String	ProcessedExtensionFilesPropertyName = "ProcessedExtensionFiles"
static readonly DependencyProperty	UserHorizontalAutoHideModeProperty
static readonly DependencyProperty	UserVerticalAutoHideModeProperty
static readonly String	CuiFrameExtention = ".cui"
static readonly String	RibbonSchemeExtention = ".ribbon"
static readonly String	XamlExtension = ".xaml"
static readonly String	ModelingRibbonFilename = "MaxModelingRibbon.xaml"
static readonly String	DefaultModelingRibbonFilename = "DefaultModelingRibbon.xaml"
static readonly String	ExtraResourcesFilepath = "ExtraResources.xaml"
static readonly String	ExtensionsFolder = "Extensions"
Protected Member Functions
virtual void	OnLoaded (RoutedEventArgs e)
virtual void	OnUnloaded (RoutedEventArgs e)
virtual void	HandleMaxscriptExecuted (object sender, MaxRibbonItemEventArgs e)
Properties
bool	IsMainToolTipOpen [get, set]
List< Uri >	ProcessedExtensionList [get, set]
	List of relative URIs to Ribbon Extension files included in this Ribbon control.
String	ProcessedExtensionFiles [get, set]
	Serialized form of ProcessedExtensionList.
RibbonAutoHideMode	UserHorizontalAutoHideMode [get, set]
RibbonAutoHideMode	UserVerticalAutoHideMode [get, set]
UserControl	HostUserControl = c842eb08-384b-4c39-a275-668d0fced14a" [get, set]
static bool	IsLoading [get, set]
	Before toggling Ribbon orientation in load command, this property should be set to true to disable the configuration saving.
ReverseBindingStorage	ReverseBindingStorage [get, set]
bool	SaveOnUnload [get, set]
	A property that determines whether this control should save itself on unload.
bool	AdjustingPanels [get, set]
	A variable indicating whether the ribbon is currently calculating panel visibility based on context.

---

Member Enumeration Documentation

enum WPFCustomControls::MaxRibbonControl::SubobjectModeEnum

Enumerator:

Undefined
Object
Vertex
Edge
Border
Polygon
Element

---

Constructor & Destructor Documentation

WPFCustomControls::MaxRibbonControl::MaxRibbonControl

(

)

[inline]

---

Member Function Documentation

void WPFCustomControls::MaxRibbonControl::UpdateRibbonItemToolTip

(

RibbonItem

item

)

[inline]

Look up a new ToolTip for the given RibbonItem, overwriting any current ToolTip.

The RibbonItem's Id is used to find the ToolTip in this MaxRibbonControl's ToolTipDictionary.

Parameters:

item	Item to update

void WPFCustomControls::MaxRibbonControl::RaiseActionItemButtonRefreshEvent

(

)

[inline]

void WPFCustomControls::MaxRibbonControl::ClearPanelDirtyFlags

(

)

[inline]

void WPFCustomControls::MaxRibbonControl::Save

(

string

configPath

)

[inline]

ICollection<MaxModelingRibbonPanel> WPFCustomControls::MaxRibbonControl::FindActionItemPanel

(

int

index

)

[inline]

Returns a collection of MaxModelingRibbonPanels panels that have a matching ActionItemIndex.

This is a wrapper collection of panels, not the source list.

Parameters:

index

An index to find matching panels for (based on ActionItemIndex property.)

Returns:

A collection of panels

virtual void WPFCustomControls::MaxRibbonControl::OnLoaded

(

RoutedEventArgs

e

)

[inline, protected, virtual]

virtual void WPFCustomControls::MaxRibbonControl::OnUnloaded

(

RoutedEventArgs

e

)

[inline, protected, virtual]

virtual void WPFCustomControls::MaxRibbonControl::HandleMaxscriptExecuted	(	object	sender,
		MaxRibbonItemEventArgs	e
	)		[inline, protected, virtual]

---

Member Data Documentation

readonly String WPFCustomControls::MaxRibbonControl::ProcessedExtensionFilesPropertyName = "ProcessedExtensionFiles" [static]

readonly DependencyProperty WPFCustomControls::MaxRibbonControl::UserHorizontalAutoHideModeProperty [static]

Initial value:

            DependencyProperty.Register(
                "UserHorizontalAutoHideMode",
                typeof(RibbonAutoHideMode),
                typeof(MaxRibbonControl),
                new PropertyMetadata(RibbonAutoHideMode.None))

readonly DependencyProperty WPFCustomControls::MaxRibbonControl::UserVerticalAutoHideModeProperty [static]

Initial value:

            DependencyProperty.Register(
                "UserVerticalAutoHideMode",
                typeof(RibbonAutoHideMode),
                typeof(MaxRibbonControl),
                new PropertyMetadata(RibbonAutoHideMode.None))

readonly String WPFCustomControls::MaxRibbonControl::CuiFrameExtention = ".cui" [static]

readonly String WPFCustomControls::MaxRibbonControl::RibbonSchemeExtention = ".ribbon" [static]

readonly String WPFCustomControls::MaxRibbonControl::XamlExtension = ".xaml" [static]

readonly String WPFCustomControls::MaxRibbonControl::ModelingRibbonFilename = "MaxModelingRibbon.xaml" [static]

readonly String WPFCustomControls::MaxRibbonControl::DefaultModelingRibbonFilename = "DefaultModelingRibbon.xaml" [static]

readonly String WPFCustomControls::MaxRibbonControl::ExtraResourcesFilepath = "ExtraResources.xaml" [static]

readonly String WPFCustomControls::MaxRibbonControl::ExtensionsFolder = "Extensions" [static]

---

Property Documentation

bool WPFCustomControls::MaxRibbonControl::IsMainToolTipOpen [get, set]

List<Uri> WPFCustomControls::MaxRibbonControl::ProcessedExtensionList [get, set]

List of relative URIs to Ribbon Extension files included in this Ribbon control.

This list enables us to avoid including an extension more than once. That could be problematic since a user could customize the conditions in his ribbon, then reload max and find that the original conditions had been restored through the ReverseBindings stored in it.

String WPFCustomControls::MaxRibbonControl::ProcessedExtensionFiles [get, set]

Serialized form of ProcessedExtensionList.

RibbonAutoHideMode WPFCustomControls::MaxRibbonControl::UserHorizontalAutoHideMode [get, set]

RibbonAutoHideMode WPFCustomControls::MaxRibbonControl::UserVerticalAutoHideMode [get, set]

UserControl WPFCustomControls::MaxRibbonControl::HostUserControl = c842eb08-384b-4c39-a275-668d0fced14a" [get, set]

bool WPFCustomControls::MaxRibbonControl::IsLoading [static, get, set]

Before toggling Ribbon orientation in load command, this property should be set to true to disable the configuration saving.

Otherwise it could cause side effects when the two Ribbons are of different minimize mode(#1240986). After toggling Ribbon orientation in load command, this property should be set to false to re-enabling the configuration saving.

ReverseBindingStorage WPFCustomControls::MaxRibbonControl::ReverseBindingStorage [get, set]

bool WPFCustomControls::MaxRibbonControl::SaveOnUnload [get, set]

A property that determines whether this control should save itself on unload.

Defaults to true.

bool WPFCustomControls::MaxRibbonControl::AdjustingPanels [get, set]

A variable indicating whether the ribbon is currently calculating panel visibility based on context.