MaxCustomControls::FormCustomizationState Class Reference

---

Detailed Description

This class stores the states of a form such as size, location.

Inheritance diagram for MaxCustomControls::FormCustomizationState:

List of all members.

Public Member Functions
	FormCustomizationState ()
	Constructor.
override Dictionary< String, String >	SaveProperties ()
	Creates a dictionary mapping keynames to properties for the properties held by this State object.
override bool	LoadProperties (Dictionary< String, String > dictionary)
	Given a dictionary mapping keyNames to properties, loads the properties into this State object.
Protected Types
enum	FormPropertyKeys { FormSize, FormLocation, FormWindowState }
	List of properties that this State class serializes. More...
Properties
FormWindowState	FormWindowState [get, set]
	A form window state - see MSDN documentation.
Size	FormSize [get, set]
	The size of the form, in pixels.
Point	FormLocation [get, set]
	The location of the form, in pixels.

---

Member Enumeration Documentation

enum MaxCustomControls::FormCustomizationState::FormPropertyKeys [protected]

List of properties that this State class serializes.

Enumerator:

FormSize
FormLocation
FormWindowState

---

Constructor & Destructor Documentation

MaxCustomControls::FormCustomizationState::FormCustomizationState

(

)

[inline]

Constructor.

---

Member Function Documentation

override Dictionary<String, String> MaxCustomControls::FormCustomizationState::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 MaxForms 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::MaterialExplorerControls::MaterialExplorerCustomizationState.

override bool MaxCustomControls::FormCustomizationState::LoadProperties

(

Dictionary< String, String >

dictionary

)

[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 MaxForms 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:

dictionary

A dictionary mapping keynames to properties.

Reimplemented from MaxCustomControls::BaseCustomizationState.

Reimplemented in MaxCustomControls::MaterialExplorerControls::MaterialExplorerCustomizationState.

---

Property Documentation

FormWindowState MaxCustomControls::FormCustomizationState::FormWindowState [get, set]

A form window state - see MSDN documentation.

Maximized, Minimized or Normal.

Size MaxCustomControls::FormCustomizationState::FormSize [get, set]

The size of the form, in pixels.

Point MaxCustomControls::FormCustomizationState::FormLocation [get, set]

The location of the form, in pixels.