.NET Windows Forms in a Nutshell

Name

ComponentEditorPage

Synopsis

This class represents a page of properties for a component that can be displayed in a ComponentEditorForm. The component to edit is determined using the SetComponent() method. It is very similar in concept to the Win32 PropertyPage control.

You can set a Title and an Icon for the page. Then, the page can be shown with the Activate() method and hidden again with Deactivate(). You can also use the CommitOnDeactivate property to determine whether the changes made to the component’s configuration should be committed before the page is deactivated. Changes are committed using the ApplyChanges() method. When all the changes have been committed by all pages in the ComponentEditorForm, the framework calls OnApplyComplete().

Help is implemented with the SupportsHelp() and ShowHelp() methods.

public abstract class ComponentEditorPage : System.Windows.Forms.Panel {

// Public Constructors

   public ComponentEditorPage();

// Public Instance Properties

   public bool CommitOnDeactivate{set; get; }

   public Icon Icon{set; get; }

   public virtual string Title{get; }

// Protected Instance Properties

   protected IComponent Component{set; get; }

   protected override CreateParams CreateParams{get; }

// overrides System.Windows.Forms.Panel

   protected bool FirstActivate{set; get; }

   protected int Loading{set; get; }

   protected bool LoadRequired{set; get; }

   protected IComponentEditorPageSite PageSite{set; get; }

// Public Instance Methods

   public virtual void Activate(); public virtual void ...