BestingIT.UIPSnap Class Reference

An instance of this class can be used to read and write properties of windows forms or controls. More...

Public Member Functions
	UIPSnap ()
	Create a new instance of UIPSnap.
void	register (string name, string key)
	Set your registration parameters (name and personal key).
string	toXML (Control control)
	Stores the UI state into an XML document. Recursively scans th UI tree and reads out properties with respect to filters. Requirements:
void	fromXML (Control control, string xml)
	Restores the UI state from an XML document Recursively scans th UI tree and writes properties.

Properties
HashSet< Type >	TypeList [get, set]
	The type list describes which property types are handled. By default string, int, byte, double, float, long, short, bool and DateTime are handled.
HashSet< string >	IncludeList [get, set]
	The include list describes which property types should be included. UIPSnap will only handle properties, whose names match any of the entries in this list. If this list is empty, all properties will be handled. By default, this list is empty.
HashSet< string >	ExcludeList [get, set]
	The exclude list describes which property types should be excluded. UIPSnap will only handle properties, whose names do not match any of the entries in this list. If this list is empty, all properties will be handled. By default, this list is empty.

Detailed Description

An instance of this class can be used to read and write properties of windows forms or controls.

Constructor & Destructor Documentation

BestingIT.UIPSnap.UIPSnap

(

)

Create a new instance of UIPSnap.

Member Function Documentation

void BestingIT.UIPSnap.fromXML	(	Control	control,
		string	xml
	)

Restores the UI state from an XML document Recursively scans th UI tree and writes properties.

Parameters

control	The (parent) control
xml

void BestingIT.UIPSnap.register	(	string	name,
		string	key
	)

Set your registration parameters (name and personal key).

Parameters

name	The name
key	The key

string BestingIT.UIPSnap.toXML

(

Control

control

)

Stores the UI state into an XML document. Recursively scans th UI tree and reads out properties with respect to filters. Requirements:

1. controls that should be handled must be tagged (set each "Tag" property to a number in the visual studio forms editor).
2. each control in the UI tree must have a unique "Name" property.

Parameters

control

The (parent) control

Returns

The XML document

Property Documentation

HashSet<string> BestingIT.UIPSnap.IncludeList

getset

The include list describes which property types should be included. UIPSnap will only handle properties, whose names match any of the entries in this list. If this list is empty, all properties will be handled. By default, this list is empty.

HashSet<Type> BestingIT.UIPSnap.TypeList

getset

The type list describes which property types are handled. By default string, int, byte, double, float, long, short, bool and DateTime are handled.

---

The documentation for this class was generated from the following file:

• UIPSnap/UIPSnap.cs