Detailed Description

A State class that represents the customization state of an explorer form.

This is the underlying Model object used to persist and serialize the customization state of an Explorer form. Clients can derive from this class to add their own customization properties.

Inheritance diagram for MaxCustomControls::ExplorerCustomizationState:

[legend]

List of all members.

Public Types
enum	PropertyKeys { InstanceName, VisibleColumnsCount, VisibleColumns, ColumnWidth, SelectChildren, EditingEnabled, ShowHierarchy, AdvancedFilterDataSource, AdvancedFilterEnabled, AdvancedFilterMatchAll, AdvancedFilterSize, AdvancedFilterLocation, ColumnSortStates, FindToolbarState, ViewSelectorToolbarState, SelectionToolbarState, ToolsToolbarState }
	List of properties that this State class serializes. More...
Public Member Functions
	ExplorerCustomizationState ()
	Empty constructor.
	ExplorerCustomizationState (int aColumnCount)
	Initializes the state object with a count value for the number of visible columns.
override bool	LoadProperties (Dictionary< String, String > aPropertySet)
	Given a dictionary mapping keyNames to properties, loads the properties into this State object.
override Dictionary< String, String >	SaveProperties ()
	Creates a dictionary mapping keynames to properties for the properties held by this State object.
Static Protected Attributes
static readonly char[]	kValueSeparator = {','}
	The separator token.
Properties
String[]	VisibleColumns `[get, set]`
	An array of visible column names - in the order that they appear in the explorer.
int[]	ColumnWidth `[get, set]`
	An array of column widths - in the order that they appear in the explorer.
String	InstanceName `[get, set]`
	The name of the explorer - as seen in the title bar of the form.
bool	SelectChildren `[get, set]`
	Is Select Children turned on?
bool	EditingEnabled `[get, set]`
	Is Editing of cell values enabled?
bool	ShowHierarchy `[get, set]`
	Is the parent-child node hierarchy being shown?
string	AdvancedFilterDataSource `[get, set]`
	The advanced filter condition data.
bool	AdvancedFilterEnabled `[get, set]`
	Is the advanced filter enabled?
Size	AdvancedFilterSize `[get, set]`
	The advanced filter dialog's size.
Point	AdvancedFilterLocation `[get, set]`
	The advanced filter dialog's absolute screen location.
bool	AdvancedFilterMatchAll `[get, set]`
	Is "Match All" in the "advanced filter" dialog checked?
List< ColumnSortState >	ColumnSortStates `[get, set]`
	The sort states of tree list columns.

Member Enumeration Documentation

enum MaxCustomControls::ExplorerCustomizationState::PropertyKeys

List of properties that this State class serializes.

Enumerator:

InstanceName
VisibleColumnsCount
VisibleColumns
ColumnWidth
SelectChildren
EditingEnabled
ShowHierarchy
AdvancedFilterDataSource
AdvancedFilterEnabled
AdvancedFilterMatchAll
AdvancedFilterSize
AdvancedFilterLocation
ColumnSortStates
FindToolbarState
ViewSelectorToolbarState
SelectionToolbarState
ToolsToolbarState

Constructor & Destructor Documentation

MaxCustomControls::ExplorerCustomizationState::ExplorerCustomizationState ( ) [inline]

Empty constructor.

MaxCustomControls::ExplorerCustomizationState::ExplorerCustomizationState ( int aColumnCount ) [inline]

Initializes the state object with a count value for the number of visible columns.

Parameters:

aColumnCount The number of visible columns in the explorer.

Member Function Documentation

override bool MaxCustomControls::ExplorerCustomizationState::LoadProperties ( Dictionary< String, String > aPropertySet ) [inline, virtual]

Given a dictionary mapping keyNames to properties, loads the properties into this State object.

KeyNames not explicitly supported by this State object are ignored.

Clients wishing to add properties to their own custom Explorers should extend this class and override this method. A call to the base implementation is still required to persist the core customization properties.

It is the client's responsibility to serialize and deserialize custom properties, since the Value type in the Dictionary is a String.

Parameters:

aPropertySet A dictionary mapping keynames to properties.

Reimplemented from MaxCustomControls::BaseCustomizationState.

Reimplemented in MaxCustomControls::BaseMaterialControls::RichMaterialExplorerControlState, MaxCustomControls::MaterialExplorerControls::SceneMaterialExplorerState, MaxCustomControls::MaterialExplorerControls::SelectedMaterialExplorerState, and MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState.

override Dictionary<String,String> MaxCustomControls::ExplorerCustomizationState::SaveProperties ( ) [inline, virtual]

Creates a dictionary mapping keynames to properties for the properties held by this State object.

Clients wishing to add properties to their own custom Explorers should extend this class and override this method. A call to the base implementation is still required to persist the core customization properties.

It is the client's responsibility to serialize and deserialize custom properties, since the Value type in the Dictionary is a String.

Returns:: A dictionary mapping keynames to property values.

Reimplemented from MaxCustomControls::BaseCustomizationState.

Reimplemented in MaxCustomControls::BaseMaterialControls::RichMaterialExplorerControlState, MaxCustomControls::MaterialExplorerControls::SceneMaterialExplorerState, MaxCustomControls::MaterialExplorerControls::SelectedMaterialExplorerState, and MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState.

Member Data Documentation

readonly char [] MaxCustomControls::ExplorerCustomizationState::kValueSeparator = {','} [static, protected]

The separator token.

Property Documentation

String [] MaxCustomControls::ExplorerCustomizationState::VisibleColumns [get, set]

An array of visible column names - in the order that they appear in the explorer.

int [] MaxCustomControls::ExplorerCustomizationState::ColumnWidth [get, set]

An array of column widths - in the order that they appear in the explorer.

String MaxCustomControls::ExplorerCustomizationState::InstanceName [get, set]

The name of the explorer - as seen in the title bar of the form.

bool MaxCustomControls::ExplorerCustomizationState::SelectChildren [get, set]

Is Select Children turned on?

bool MaxCustomControls::ExplorerCustomizationState::EditingEnabled [get, set]

Is Editing of cell values enabled?

bool MaxCustomControls::ExplorerCustomizationState::ShowHierarchy [get, set]

Is the parent-child node hierarchy being shown?

string MaxCustomControls::ExplorerCustomizationState::AdvancedFilterDataSource [get, set]

The advanced filter condition data.

bool MaxCustomControls::ExplorerCustomizationState::AdvancedFilterEnabled [get, set]

Is the advanced filter enabled?

Size MaxCustomControls::ExplorerCustomizationState::AdvancedFilterSize [get, set]

The advanced filter dialog's size.

Point MaxCustomControls::ExplorerCustomizationState::AdvancedFilterLocation [get, set]

The advanced filter dialog's absolute screen location.

bool MaxCustomControls::ExplorerCustomizationState::AdvancedFilterMatchAll [get, set]

Is "Match All" in the "advanced filter" dialog checked?

List<ColumnSortState> MaxCustomControls::ExplorerCustomizationState::ColumnSortStates [get, set]

The sort states of tree list columns.

MaxCustomControls::ExplorerCustomizationState Class Reference

Detailed Description

Public Types

Public Member Functions

Static Protected Attributes

Properties

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation