PageSummary Class

PageSummary Class

A class that exposes the summary information for a Page.

Inheritance Hierarchy

SystemObject
VirtualRadar.WinForms.SettingPagePageSummary
More...

Namespace: VirtualRadar.WinForms.SettingPage
Assembly: VirtualRadar.WinForms (in VirtualRadar.WinForms.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public abstract class PageSummary

Public MustInherit Class PageSummary

public ref class PageSummary abstract

[<AbstractClassAttribute>]
type PageSummary =  class end

The PageSummary type exposes the following members.

Constructors

	Name	Description
	PageSummary	Creates a new object.

Top

Properties

	Name	Description
	ChildPages	Gets a list of all child summaries.
	Page	Gets or sets the page associated with the summary.
	PageEnabled	Gets a value indicating that the page should be shown as enabled in the list of pages.
	PageIcon	Gets the icon for the page.
	PageObject	Gets the settings object being modified by this page.
	PageTitle	Gets the title for the page.
	SettingsView	Gets or sets the view that owns this summary.
	ShowChildPagesInAlphabeticalOrder	Gets a value indicating that child pages are to be shown in alphabetical order of PageTitle. False by default unless the child pages are associated with a list.
	TreeNode	Gets or sets the tree node that represents this summary.

Top

Methods

	Name	Description
	AssociateChildPages	Gives the derived class the opportunity to synchronise its child pages list with something (or just create them if they're not associated with anything).
	AssociateValidationFields	Associates controls with validation fields.
	CreatePage	Creates the page for display.
	DoCreatePage	Creates the page.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetControlForValidationField	Returns the control associated with the field passed across. Returns null if the pageObject passed across does not match the pageObject held by the page.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetPageEnabledPropertyT	Sets up the automatic page enabled fetcher.
	SetPageTitlePropertyT	Sets up the automatic page title fetcher.
	SetValidationFields	Records which controls display which validation fields.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	_ValidationFieldControlMap	A map of validation fields to the controls that they represent.

Top

Remarks

In beta testing of the new options screens it was found that the options screen for installations with a large number of feeds were taking a very long time to open. This was because each page is a user control, and all of the user controls had to be created before the screen was shown.

Having pages as user controls is quite attractive for a number of reasons, but a way had to be found to defer the creation of them until the user actually wants them. To this end we have this object. It carries the information that the options screen tree view needs from a page and it also carries the page itself. The page summaries are created by the options screen and associated with tree view nodes. When the user clicks a node, or causes a node to be selected, the code creates the page (if it doesn't already exist) and adds it to the options screen. The options screen opens faster but the drawback is that switching to a new page has some overhead while the page is created.

Reference

VirtualRadar.WinForms.SettingPage Namespace

Inheritance Hierarchy