NDoc.Core

NDoc Documentation

NDoc.Core Namespace

The NDoc.Core namespace contains the core functionality of NDoc as well as interfaces and base classes to build specific documenters.

Classes

Class | Description
AssemblyResolver | Resolves assemblies located in a specified directory and its sub-directories.
AssemblySlashDoc | Represents an assembly and /doc pair.
AttributesEditor | Class which implements a custom UITypeEditor for attributes.
AttributesForm | A form to build attributes filter criteria.
AttributeToShow | Class which holds information about an attribute.
BaseDocumenter | Provides the base class for documenters.
BaseDocumenterConfig | The base documenter config class.
CouldNotLoadAllAssembliesException | This exception is thrown when one or more assemblies can not be loaded.
DocumenterException | Represents the exceptions that are thrown when attempting to build documentation.
EmbeddedResources | Utilties to help reading and writing embedded resources.
HtmlHelp | HTML Help file utilities.
ProgressArgs | Custom event arguments' class used by DocBuildingEventHandler.
Project | Represents an NDoc project.
Project.AssemblyAlreadyExistsException | A custom exception to detect if a duplicate assembly is beeing added.
SimpleEdit | This is a dialog box to prompt for a name.
TemplateWriter | Stream writer that parses a template file to write a new file.
TextEditor | Provides editing facilities for large blocks of text in the PropertyGrid.
TextEditorForm | Used in the conjunction with the TextEditor, this form provides the user a larger interface with which to edit text.
XmlDocumentationCache | Caches XML Documentation files and summaries.

Interfaces

Interface | Description
IDocumenter | Represents a class capable of generating documentation from a given assembly and /doc file.
IDocumenterConfig | Specifies the methods that are common to all documenter configs.

Delegates

Delegate | Description
DocBuildingEventHandler | Used by IDocumenter's events to notify doc building progress.
ProjectModifiedEventHandler | Handles ProjectModified events.

Enumerations

Enumeration | Description
DocumenterDevelopmentStatus | This is used to indicate the development status of each documenter.
EditorBrowsableFilterLevel | Define the levels of filtering on the EditorBrowsable attribute.

Copyright © 2000-2003 the NDoc Team


AssemblyResolver Class

Resolves assemblies located in a specified directory and its sub-directories.

For a list of all members of this type, see AssemblyResolver Members.

System.Object
AssemblyResolver

public class AssemblyResolver

Remarks

Class AssemblyResolver resolves assemblies not found by the system. An instance of this class is configured with a base directory and hooks up to the AppDomain.AssemblyResolve event. Whenever called, the instance checks the associated directory with all subdirectories for the assembly requested.

The class implements two features to speed up the search:

  • AssemblyList: Before searching the file system, the assembly list is searched. Once an assembly has been found, it is added to the AssemblyList.
  • SubDirectoryCache: The class caches the subdirectories of each directory once they have been determined. This avoids repeated filesystem queries for subdirectories.

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

AssemblyResolver Members | NDoc.Core Namespace

Copyright © 2000-2003 the NDoc Team

Generated from assembly NDoc.Core [1.2.1300.31138]


AssemblyResolver Members

AssemblyResolver overview

Public Instance Constructors

AssemblyResolver Constructor Constructs an instance of this type.

Public Instance Properties

IncludeSubdirs Whether or not to include sub-directories in the searches which are in response to the AssemblyResolve event.

Public Instance Methods

Deinstall | Deinstalls the assembly resolver.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) | Gets the Type of the current instance.
Install | Installs the assembly resolver by hooking up to the AppDomain's AssemblyResolve event.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
ResolveAssembly | Resolves the location and loads an assembly not found by the system.

See Also

AssemblyResolver Class | NDoc.Core Namespace


AssemblyResolver Constructor

Constructs an instance of this type.

public AssemblyResolver(
ArrayList directories
);

Parameters

directories
A list of directories to search for assemblies in.

See Also

AssemblyResolver Class | NDoc.Core Namespace


AssemblyResolver Properties

The properties of the AssemblyResolver class are listed below. For a complete list of AssemblyResolver class members, see the AssemblyResolver Members topic.

Public Instance Properties

IncludeSubdirs Whether or not to include sub-directories in the searches which are in response to the AssemblyResolve event.

See Also

AssemblyResolver Class | NDoc.Core Namespace


AssemblyResolver.IncludeSubdirs Property

Whether or not to include sub-directories in the searches which are in response to the AssemblyResolve event.

public bool IncludeSubdirs {get; set;}

See Also

AssemblyResolver Class | NDoc.Core Namespace


AssemblyResolver Methods

The methods of the AssemblyResolver class are listed below. For a complete list of AssemblyResolver class members, see the AssemblyResolver Members topic.

Public Instance Methods

Deinstall | Deinstalls the assembly resolver.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) | Gets the Type of the current instance.
Install | Installs the assembly resolver by hooking up to the AppDomain's AssemblyResolve event.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
ResolveAssembly | Resolves the location and loads an assembly not found by the system.

See Also

AssemblyResolver Class | NDoc.Core Namespace


AssemblyResolver.Deinstall Method

Deinstalls the assembly resolver.

public void Deinstall();

See Also

AssemblyResolver Class | NDoc.Core Namespace


AssemblyResolver.Install Method

Installs the assembly resolver by hooking up to the AppDomain's AssemblyResolve event.

public void Install();

See Also

AssemblyResolver Class | NDoc.Core Namespace


AssemblyResolver.ResolveAssembly Method

Resolves the location and loads an assembly not found by the system.

protected Assembly ResolveAssembly(
object sender,
ResolveEventArgs args
);

Parameters

sender
the sender of the event
args
event arguments

Return Value

the loaded assembly, null, if not found

See Also

AssemblyResolver Class | NDoc.Core Namespace


AssemblySlashDoc Class

Represents an assembly and /doc pair.

For a list of all members of this type, see AssemblySlashDoc Members.

System.Object
AssemblySlashDoc

public class AssemblySlashDoc

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

AssemblySlashDoc Members | NDoc.Core Namespace


AssemblySlashDoc Members

AssemblySlashDoc overview

Public Instance Constructors

AssemblySlashDoc Overloaded. Initializes a new instance of the AssemblySlashDoc class.

Public Instance Properties

AssemblyFilename | Gets or sets the assembly filename in this pair.
SlashDocFilename | Gets or sets the /doc filename in this pair.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

AssemblySlashDoc Class | NDoc.Core Namespace


AssemblySlashDoc Constructor

Initializes a new instance of the AssemblySlashDoc class.

Overload List

Initializes a new instance of the AssemblySlashDoc class.

public AssemblySlashDoc();

Initializes a new instance of the AssemblySlashDoc class to the values indicated.

public AssemblySlashDoc(string,string);

See Also

AssemblySlashDoc Class | NDoc.Core Namespace


AssemblySlashDoc Constructor ()

Initializes a new instance of the AssemblySlashDoc class.

public AssemblySlashDoc();

See Also

AssemblySlashDoc Class | NDoc.Core Namespace | AssemblySlashDoc Constructor Overload List


AssemblySlashDoc Constructor (String, String)

Initializes a new instance of the AssemblySlashDoc class to the values indicated.

public AssemblySlashDoc(
string assemblyFilename,
string slashDocFilename
);

Parameters

assemblyFilename
An assembly filename.
slashDocFilename
A /doc filename.

See Also

AssemblySlashDoc Class | NDoc.Core Namespace | AssemblySlashDoc Constructor Overload List


AssemblySlashDoc Properties

The properties of the AssemblySlashDoc class are listed below. For a complete list of AssemblySlashDoc class members, see the AssemblySlashDoc Members topic.

Public Instance Properties

AssemblyFilename | Gets or sets the assembly filename in this pair.
SlashDocFilename | Gets or sets the /doc filename in this pair.

See Also

AssemblySlashDoc Class | NDoc.Core Namespace


AssemblySlashDoc.AssemblyFilename Property

Gets or sets the assembly filename in this pair.

public string AssemblyFilename {get; set;}

See Also

AssemblySlashDoc Class | NDoc.Core Namespace


AssemblySlashDoc.SlashDocFilename Property

Gets or sets the /doc filename in this pair.

public string SlashDocFilename {get; set;}

See Also

AssemblySlashDoc Class | NDoc.Core Namespace


AttributesEditor Class

Class which implements a custom UITypeEditor for attributes.

For a list of all members of this type, see AttributesEditor Members.

System.Object
UITypeEditor
AttributesEditor

public class AttributesEditor : UITypeEditor

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

AttributesEditor Members | NDoc.Core Namespace


AttributesEditor Members

AttributesEditor overview

Public Instance Constructors

AttributesEditor Constructor Initializes a new instance of the AttributesEditor class.

Public Instance Methods

EditValue | Overloaded. Handler called when editing a value.
EditValue (inherited from UITypeEditor) | Overloaded. Edits the value of the specified object using the editor style indicated by GetEditStyle.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetEditStyle | Overloaded. Returns the edit style for the type.
GetEditStyle (inherited from UITypeEditor) | Overloaded. Gets the editor style used by the EditValue method.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetPaintValueSupported (inherited from UITypeEditor) | Overloaded. Indicates whether the specified context supports painting a representation of an object's value within the specified context.
GetType (inherited from Object) | Gets the Type of the current instance.
PaintValue (inherited from UITypeEditor) | Overloaded. Paints a representation of the value of an object using the specified PaintValueEventArgs.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

AttributesEditor Class | NDoc.Core Namespace


AttributesEditor Constructor

Initializes a new instance of the AttributesEditor class.

public AttributesEditor();

See Also

AttributesEditor Class | NDoc.Core Namespace


AttributesEditor Methods

The methods of the AttributesEditor class are listed below. For a complete list of AttributesEditor class members, see the AttributesEditor Members topic.

Public Instance Methods

EditValue | Overloaded. Handler called when editing a value.
EditValue (inherited from UITypeEditor) | Overloaded. Edits the value of the specified object using the editor style indicated by GetEditStyle.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetEditStyle | Overloaded. Returns the edit style for the type.
GetEditStyle (inherited from UITypeEditor) | Overloaded. Gets the editor style used by the EditValue method.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetPaintValueSupported (inherited from UITypeEditor) | Overloaded. Indicates whether the specified context supports painting a representation of an object's value within the specified context.
GetType (inherited from Object) | Gets the Type of the current instance.
PaintValue (inherited from UITypeEditor) | Overloaded. Paints a representation of the value of an object using the specified PaintValueEventArgs.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

AttributesEditor Class | NDoc.Core Namespace


EditValue Method

NDoc Documentation

AttributesEditor.EditValue Method

Handler called when editing a value.

Overload List

Handler called when editing a value.

public override object EditValue(ITypeDescriptorContext,IServiceProvider,object);

Inherited from UITypeEditor.

public object EditValue(IServiceProvider,object);

See Also

AttributesEditor Class | NDoc.Core Namespace


AttributesEditor.EditValue Method (ITypeDescriptorContext, IServiceProvider, Object)

Handler called when editing a value.

public override object EditValue(
ITypeDescriptorContext context,
IServiceProvider provider,
object value
);

Parameters

context
Context
provider
Provider
value
Current Value

Return Value

New value

See Also

AttributesEditor Class | NDoc.Core Namespace | AttributesEditor.EditValue Overload List


GetEditStyle Method

NDoc Documentation

AttributesEditor.GetEditStyle Method

Returns the edit style for the type.

Overload List

Inherited from UITypeEditor.

public UITypeEditorEditStyle GetEditStyle();

Returns the edit style for the type.

public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext);

See Also

AttributesEditor Class | NDoc.Core Namespace


AttributesEditor.GetEditStyle Method (ITypeDescriptorContext)

Returns the edit style for the type.

public override UITypeEditorEditStyle GetEditStyle(
ITypeDescriptorContext context
);

Parameters

context
Context

Return Value

Edit Style

See Also

AttributesEditor Class | NDoc.Core Namespace | AttributesEditor.GetEditStyle Overload List


AttributesForm Class

A form to build attributes filter criteria.

For a list of all members of this type, see AttributesForm Members.

System.Object
MarshalByRefObject
Component
Control
ScrollableControl
ContainerControl
Form
AttributesForm

public class AttributesForm : Form

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

AttributesForm Members | NDoc.Core Namespace


AttributesForm Members

AttributesForm overview

Public Instance Constructors

AttributesForm Constructor Creates and initialize a new AttributesForm object.

Public Instance Fields

Value Contains the updated value, if the user clicked OK.

Public Instance Properties

AcceptButton (inherited from Form) | Gets or sets the button on the form that is clicked when the user presses the ENTER key.
AccessibilityObject (inherited from Control) | Gets the AccessibleObject assigned to the control.
AccessibleDefaultActionDescription (inherited from Control) | Gets or sets the default action description of the control for use by accessibility client applications.
AccessibleDescription (inherited from Control) | Gets or sets the description of the control used by accessibility client applications.
AccessibleName (inherited from Control) | Gets or sets the name of the control used by accessibility client applications.
AccessibleRole (inherited from Control) | Gets or sets the accessible role of the control
ActiveControl (inherited from ContainerControl) | Gets or sets the active control on the container control.
ActiveMdiChild (inherited from Form) | Gets the currently active multiple document interface (MDI) child window.
AllowDrop (inherited from Control) | Gets or sets a value indicating whether the control can accept data that the user drags onto it.
AllowTransparency (inherited from Form) |
Anchor (inherited from Control) | Gets or sets which edges of the control are anchored to the edges of its container.
AutoScale (inherited from Form) | Gets or sets a value indicating whether the form adjusts its size to fit the height of the font used on the form and scales its controls.
AutoScaleBaseSize (inherited from Form) | Gets or sets the base size used for autoscaling of the form.
AutoScroll (inherited from Form) | Gets or sets a value indicating whether the form enables autoscrolling.
AutoScrollMargin (inherited from ScrollableControl) | Gets or sets the size of the auto-scroll margin.
AutoScrollMinSize (inherited from ScrollableControl) | Gets or sets the minimum size of the auto-scroll.
AutoScrollPosition (inherited from ScrollableControl) | Gets or sets the location of the auto-scroll position.
BackColor (inherited from Form) |
BackgroundImage (inherited from Control) | Gets or sets the background image displayed in the control.
BindingContext (inherited from ContainerControl) |
Bottom (inherited from Control) | Gets the distance between the bottom edge of the control and the top edge of its container's client area.
Bounds (inherited from Control) | Gets or sets the size and location of the control including its nonclient elements.
CancelButton (inherited from Form) | Gets or sets the button control that is clicked when the user presses the ESC key.
CanFocus (inherited from Control) | Gets a value indicating whether the control can receive focus.
CanSelect (inherited from Control) | Gets a value indicating whether the control can be selected.
Capture (inherited from Control) | Gets or sets a value indicating whether the control has captured the mouse.
CausesValidation (inherited from Control) | Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
ClientRectangle (inherited from Control) | Gets the rectangle that represents the client area of the control.
ClientSize (inherited from Form) | Gets or sets the size of the client area of the form.
CompanyName (inherited from Control) | Gets the name of the company or creator of the application containing the control.
Container (inherited from Component) | Gets the IContainer that contains the Component.
ContainsFocus (inherited from Control) | Gets a value indicating whether the control, or one of its child controls, currently has the input focus.
ContextMenu (inherited from Control) | Gets or sets the shortcut menu associated with the control.
ControlBox (inherited from Form) | Gets or sets a value indicating whether a control box is displayed in the caption bar of the form.
Controls (inherited from Control) | Gets the collection of controls contained within the control.
Created (inherited from Control) | Gets a value indicating whether the control has been created.
Cursor (inherited from Control) | Gets or sets the cursor that is displayed when the mouse pointer is over the control.
DataBindings (inherited from Control) | Gets the data bindings for the control.
DesktopBounds (inherited from Form) | Gets or sets the size and location of the form on the Windows desktop.
DesktopLocation (inherited from Form) | Gets or sets the location of the form on the Windows desktop.
DialogResult (inherited from Form) | Gets or sets the dialog result for the form.
DisplayRectangle (inherited from ScrollableControl) |
Disposing (inherited from Control) | Gets a value indicating whether the control is in the process of being disposed of.
Dock (inherited from Control) | Gets or sets which edge of the parent container a control is docked to.
DockPadding (inherited from ScrollableControl) | Gets the dock padding settings for all edges of the control.
Enabled (inherited from Control) | Gets or sets a value indicating whether the control can respond to user interaction.
Focused (inherited from Control) | Gets a value indicating whether the control has input focus.
Font (inherited from Control) | Gets or sets the font of the text displayed by the control.
ForeColor (inherited from Control) | Gets or sets the foreground color of the control.
FormBorderStyle (inherited from Form) | Gets or sets the border style of the form.
Handle (inherited from Control) | Gets the window handle that the control is bound to.
HasChildren (inherited from Control) | Gets a value indicating whether the control contains one or more child controls.
Height (inherited from Control) | Gets or sets the height of the control.
HelpButton (inherited from Form) | Gets or sets a value indicating whether a Help button should be displayed in the caption box of the form.
Icon (inherited from Form) | Gets or sets the icon for the form.
ImeMode (inherited from Control) | Gets or sets the Input Method Editor (IME) mode of the control.
InvokeRequired (inherited from Control) | Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on.
IsAccessible (inherited from Control) | Gets or sets a value indicating whether the control is visible to accessibility applications.
IsDisposed (inherited from Control) | Gets a value indicating whether the control has been disposed of.
IsHandleCreated (inherited from Control) | Gets a value indicating whether the control has a handle associated with it.
IsMdiChild (inherited from Form) | Gets a value indicating whether the form is a multiple document interface (MDI) child form.
IsMdiContainer (inherited from Form) | Gets or sets a value indicating whether the form is a container for multiple document interface (MDI) child forms.
IsRestrictedWindow (inherited from Form) |
KeyPreview (inherited from Form) | Gets or sets a value indicating whether the form will receive key events before the event is passed to the control that has focus.
Left (inherited from Control) | Gets or sets the x-coordinate of a control's left edge in pixels.
Location (inherited from Control) | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
MaximizeBox (inherited from Form) | Gets or sets a value indicating whether the maximize button is displayed in the caption bar of the form.
MaximumSize (inherited from Form) | Gets the maximum size the form can be resized to.
MdiChildren (inherited from Form) | Gets an array of forms that represent the multiple document interface (MDI) child forms that are parented to this form.
MdiParent (inherited from Form) | Gets or sets the current multiple document interface (MDI) parent form of this form.
Menu (inherited from Form) | Gets or sets the MainMenu that is displayed in the form.
MergedMenu (inherited from Form) | Gets the merged menu for the form.
MinimizeBox (inherited from Form) | Gets or sets a value indicating whether the minimize button is displayed in the caption bar of the form.
MinimumSize (inherited from Form) | Gets or sets the minimum size the form can be resized to.
Modal (inherited from Form) | Gets a value indicating whether this form is displayed modally.
Name (inherited from Control) | Gets or sets the name of the control.
Opacity (inherited from Form) | Gets or sets the opacity level of the form.
OwnedForms (inherited from Form) | Gets an array of Form objects that represent all forms that are owned by this form.
Owner (inherited from Form) | Gets or sets the form that owns this form.
Parent (inherited from Control) | Gets or sets the parent container of the control.
ParentForm (inherited from ContainerControl) | Gets the form that the container control is assigned to.
ProductName (inherited from Control) | Gets the product name of the assembly containing the control.
ProductVersion (inherited from Control) | Gets the version of the assembly containing the control.
RecreatingHandle (inherited from Control) | Gets a value indicating whether the control is currently re-creating its handle.
Region (inherited from Control) | Gets or sets the window region associated with the control.
Right (inherited from Control) | Gets the distance between the right edge of the control and the left edge of its container.
RightToLeft (inherited from Control) | Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
ShowInTaskbar (inherited from Form) | Gets or sets a value indicating whether the form is displayed in the Windows taskbar.
Site (inherited from Control) | Gets or sets the site of the control.
Size (inherited from Form) | Gets or sets the size of the form.
SizeGripStyle (inherited from Form) | Gets or sets the style of the size grip to display in the lower-right corner of the form.
StartPosition (inherited from Form) | Gets or sets the starting position of the form at run time.
TabIndex (inherited from Form) |
TabStop (inherited from Control) | Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
Tag (inherited from Control) | Gets or sets the object that contains data about the control.
Text (inherited from Control) | Gets or sets the text associated with this control.
Top (inherited from Control) | Gets or sets the y-coordinate of the control's top edge in pixels.
TopLevel (inherited from Form) | Gets or sets a value indicating whether to display the form as a top-level window.
TopLevelControl (inherited from Control) | Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
TopMost (inherited from Form) | Gets or sets a value indicating whether the form should be displayed as the top-most form of your application.
TransparencyKey (inherited from Form) | Gets or sets the color that will represent transparent areas of the form.
Visible (inherited from Control) | Gets or sets a value indicating whether the control is displayed.
Width (inherited from Control) | Gets or sets the width of the control.
WindowState (inherited from Form) | Gets or sets the form's window state.
WindowTarget (inherited from Control) |

Public Instance Methods

Activate (inherited from Form) | Activates the form and gives it focus.
AddOwnedForm (inherited from Form) | Adds an owned form to this form.
BeginInvoke (inherited from Control) | Overloaded. Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
BringToFront (inherited from Control) | Brings the control to the front of the z-order.
Close (inherited from Form) | Closes the form.
Contains (inherited from Control) | Retrieves a value indicating whether the specified control is a child of the control.
CreateControl (inherited from Control) | Forces the creation of the control, including the creation of the handle and any child controls.
CreateGraphics (inherited from Control) | Creates the Graphics object for the control.
CreateObjRef (inherited from MarshalByRefObject) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose (inherited from Component) | Overloaded. Releases all resources used by the Component.
DoDragDrop (inherited from Control) | Begins a drag-and-drop operation.
EndInvoke (inherited from Control) | Retrieves the return value of the asynchronous operation represented by the IAsyncResult object passed.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
FindForm (inherited from Control) | Retrieves the form that the control is on.
Focus (inherited from Control) | Sets input focus to the control.
GetChildAtPoint (inherited from Control) | Retrieves the child control that is located at the specified coordinates.
GetContainerControl (inherited from Control) | Returns the next ContainerControl up the control's chain of parent controls.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) | Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetNextControl (inherited from Control) | Retrieves the next control forward or back in the tab order of child controls.
GetType (inherited from Object) | Gets the Type of the current instance.
Hide (inherited from Control) | Conceals the control from the user.
InitializeLifetimeService (inherited from MarshalByRefObject) | Obtains a lifetime service object to control the lifetime policy for this instance.
Invalidate (inherited from Control) | Overloaded. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
Invoke (inherited from Control) | Overloaded. Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
LayoutMdi (inherited from Form) | Arranges the multiple document interface (MDI) child forms within the MDI parent form.
PerformLayout (inherited from Control) | Overloaded. Forces the control to apply layout logic to all its child controls.
PointToClient (inherited from Control) | Computes the location of the specified screen point into client coordinates.
PointToScreen (inherited from Control) | Computes the location of the specified client point into screen coordinates.
PreProcessMessage (inherited from Control) | Preprocesses input messages within the message loop before they are dispatched.
RectangleToClient (inherited from Control) | Computes the size and location of the specified screen rectangle in client coordinates.
RectangleToScreen (inherited from Control) | Computes the size and location of the specified client rectangle in screen coordinates.
Refresh (inherited from Control) | Forces the control to invalidate its client area and immediately redraw itself and any child controls.
RemoveOwnedForm (inherited from Form) | Removes an owned form from this form.
ResetBackColor (inherited from Control) | Resets the BackColor property to its default value.
ResetBindings (inherited from Control) | Resets the DataBindings property to its default value.
ResetCursor (inherited from Control) | Resets the Cursor property to its default value.
ResetFont (inherited from Control) | Resets the Fontproperty to its default value.
ResetForeColor (inherited from Control) | Resets the ForeColor property to its default value.
ResetImeMode (inherited from Control) | Resets the ImeMode property to its default value.
ResetRightToLeft (inherited from Control) | Resets the RightToLeft property to its default value.
ResetText (inherited from Control) | Resets the Text property to its default value.
ResumeLayout (inherited from Control) | Overloaded. Resumes normal layout logic.
Scale (inherited from Control) | Overloaded. Scales the control and any child controls to the specified ratio.
ScrollControlIntoView (inherited from ScrollableControl) |
Select (inherited from Control) | Overloaded. Activates the control.
SelectNextControl (inherited from Control) | Activates the next control.
SendToBack (inherited from Control) | Sends the control to the back of the z-order.
SetAutoScrollMargin (inherited from ScrollableControl) | Sets the size of the auto-scroll margins.
SetBounds (inherited from Control) | Overloaded. Sets the bounds of the control to the specified location and size.
SetDesktopBounds (inherited from Form) | Sets the bounds of the form in desktop coordinates.
SetDesktopLocation (inherited from Form) | Sets the location of the form in desktop coordinates.
Show (inherited from Control) | Displays the control to the user.
ShowDialog (inherited from Form) | Overloaded. Shows the form as a modal dialog box with no owner window.
SuspendLayout (inherited from Control) | Temporarily suspends the layout logic for the control.
ToString (inherited from Form) |
Update (inherited from Control) | Causes the control to redraw the invalidated regions within its client area.
Validate (inherited from ContainerControl) | Validates the last invalidated control and its ancestors up through, but not including, the current control.

Public Instance Events

Activated (inherited from Form) | Occurs when the form is activated in code or by the user.
BackColorChanged (inherited from Control) | Occurs when the value of the BackColor property changes.
BackgroundImageChanged (inherited from Control) | Occurs when the value of the BackgroundImage property changes.
BindingContextChanged (inherited from Control) | Occurs when the value of the BindingContext property changes.
CausesValidationChanged (inherited from Control) | Occurs when the value of the CausesValidation property changes.
ChangeUICues (inherited from Control) | Occurs when the focus or keyboard user interface (UI) cues change.
Click (inherited from Control) | Occurs when the control is clicked.
Closed (inherited from Form) | Occurs when the form is closed.
Closing (inherited from Form) | Occurs when the form is closing.
ContextMenuChanged (inherited from Control) | Occurs when the value of the ContextMenu property changes.
ControlAdded (inherited from Control) | Occurs when a new control is added to the ControlCollection .
ControlRemoved (inherited from Control) | Occurs when a control is removed from the ControlCollection .
CursorChanged (inherited from Control) | Occurs when the value of the Cursor property changes.
Deactivate (inherited from Form) | Occurs when the form loses focus and is not the active form.
Disposed (inherited from Component) | Adds an event handler to listen to the Disposed event on the component.
DockChanged (inherited from Control) | Occurs when the value of the Dock property changes.
DoubleClick (inherited from Control) | Occurs when the control is double-clicked.
DragDrop (inherited from Control) | Occurs when a drag-and-drop operation is completed.
DragEnter (inherited from Control) | Occurs when an object is dragged into the control's bounds.
DragLeave (inherited from Control) | Occurs when an object is dragged out of the control's bounds.
DragOver (inherited from Control) | Occurs when an object is dragged over the control's bounds.
EnabledChanged (inherited from Control) | Occurs when the Enabled property value has changed.
Enter (inherited from Control) | Occurs when the control is entered.
FontChanged (inherited from Control) | Occurs when the Font property value changes.
ForeColorChanged (inherited from Control) | Occurs when the ForeColor property value changes.
GiveFeedback (inherited from Control) | Occurs during a drag operation.
GotFocus (inherited from Control) | Occurs when the control receives focus.
HandleCreated (inherited from Control) | Occurs when a handle is created for the control.
HandleDestroyed (inherited from Control) | Occurs when the control's handle is in the process of being destroyed.
HelpRequested (inherited from Control) | Occurs when the user requests help for a control.
ImeModeChanged (inherited from Control) | Occurs when the ImeMode property has changed.
InputLanguageChanged (inherited from Form) | Occurs after the input language of the form has changed.
InputLanguageChanging (inherited from Form) | Occurs when the user attempts to change the input language for the form.
Invalidated (inherited from Control) | Occurs when a control's display requires redrawing.
KeyDown (inherited from Control) | Occurs when a key is pressed while the control has focus.
KeyPress (inherited from Control) | Occurs when a key is pressed while the control has focus.
KeyUp (inherited from Control) | Occurs when a key is released while the control has focus.
Layout (inherited from Control) | Occurs when a control should reposition its child controls.
Leave (inherited from Control) | Occurs when the input focus leaves the control.
Load (inherited from Form) | Occurs before a form is displayed for the first time.
LocationChanged (inherited from Control) | Occurs when the Location property value has changed.
LostFocus (inherited from Control) | Occurs when the control loses focus.
MaximizedBoundsChanged (inherited from Form) | Occurs when the value of the MaximizedBounds property has changed.
MaximumSizeChanged (inherited from Form) | Occurs when the value of the MaximumSize property has changed.
MdiChildActivate (inherited from Form) | Occurs when a multiple document interface (MDI) child form is activated or closed within an MDI application.
MenuComplete (inherited from Form) | Occurs when the menu of a form loses focus.
MenuStart (inherited from Form) | Occurs when the menu of a form receives focus.
MinimumSizeChanged (inherited from Form) | Occurs when the value of the MinimumSize property has changed.
MouseDown (inherited from Control) | Occurs when the mouse pointer is over the control and a mouse button is pressed.
MouseEnter (inherited from Control) | Occurs when the mouse pointer enters the control.
MouseHover (inherited from Control) | Occurs when the mouse pointer hovers over the control.
MouseLeave (inherited from Control) | Occurs when the mouse pointer leaves the control.
MouseMove (inherited from Control) | Occurs when the mouse pointer is moved over the control.
MouseUp (inherited from Control) | Occurs when the mouse pointer is over the control and a mouse button is released.
MouseWheel (inherited from Control) | Occurs when the mouse wheel moves while the control has focus.
Move (inherited from Control) | Occurs when the control is moved.
Paint (inherited from Control) | Occurs when the control is redrawn.
ParentChanged (inherited from Control) | Occurs when the Parent property value changes.
QueryAccessibilityHelp (inherited from Control) | Occurs when AccessibleObject is providing help to accessibility applications.
QueryContinueDrag (inherited from Control) | Occurs during a drag-and-drop operation and allows the drag source to determine whether the drag-and-drop operation should be canceled.
Resize (inherited from Control) | Occurs when the control is resized.
RightToLeftChanged (inherited from Control) | Occurs when the RightToLeft property value changes.
SizeChanged (inherited from Control) | Occurs when the Size property value changes.
StyleChanged (inherited from Control) | Occurs when the control style changes.
SystemColorsChanged (inherited from Control) | Occurs when the system colors change.
TabIndexChanged (inherited from Form) |
TabStopChanged (inherited from Control) | Occurs when the TabStop property value changes.
TextChanged (inherited from Control) | Occurs when the Text property value changes.
Validated (inherited from Control) | Occurs when the control is finished validating.
Validating (inherited from Control) | Occurs when the control is validating.
VisibleChanged (inherited from Control) | Occurs when the Visible property value changes.

Protected Instance Properties

CreateParams (inherited from Form) |
DefaultImeMode (inherited from Form) | Gets the default Input Method Editor (IME) mode supported by the control.
DefaultSize (inherited from Form) |
DesignMode (inherited from Component) | Gets a value that indicates whether the Component is currently in design mode.
Events (inherited from Component) | Gets the list of event handlers that are attached to this Component.
FontHeight (inherited from Control) | Gets or sets the height of the font of the control.
HScroll (inherited from ScrollableControl) | Gets or sets a value indicating whether the horizontal scroll bar is visible.
MaximizedBounds (inherited from Form) | Gets and sets the size of the form when it is maximized.
RenderRightToLeft (inherited from Control) |
ResizeRedraw (inherited from Control) | Gets or sets a value indicating whether the control redraws itself when resized.
ShowFocusCues (inherited from Control) | Gets a value indicating whether the control should display focus rectangles.
ShowKeyboardCues (inherited from Control) | Gets a value indicating whether the control should display keyboard shortcuts.
VScroll (inherited from ScrollableControl) | Gets or sets a value indicating whether the vertical scroll bar is visible.

Protected Instance Methods

AccessibilityNotifyClients (inherited from Control) | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control.
ActivateMdiChild (inherited from Form) |
AdjustFormScrollbars (inherited from Form) |
ApplyAutoScaling (inherited from Form) |
CenterToParent (inherited from Form) |
CenterToScreen (inherited from Form) |
CreateAccessibilityInstance (inherited from Control) | Creates a new accessibility object for the control.
CreateControlsInstance (inherited from Form) |
CreateHandle (inherited from Form) |
DefWndProc (inherited from Form) |
DestroyHandle (inherited from Control) | Destroys the handle associated with the control.
Dispose | Overloaded. Clean up any resources being used.
Finalize (inherited from Component) | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
GetScrollState (inherited from ScrollableControl) |
GetService (inherited from Component) | Returns an object that represents a service provided by the Component or by its Container.
GetStyle (inherited from Control) | Retrieves the value of the specified control style bit for the control.
GetTopLevel (inherited from Control) | Determines if the control is a top-level control.
InitLayout (inherited from Control) | Called after the control has been added to another container.
InvokeGotFocus (inherited from Control) | Raises the GotFocus event for the specified control.
InvokeLostFocus (inherited from Control) | Raises the LostFocus event for the specified control.
InvokeOnClick (inherited from Control) | Raises the Click event for the specified control.
InvokePaint (inherited from Control) | Raises the Paint event for the specified control.
InvokePaintBackground (inherited from Control) | Raises the PaintBackground event for the specified control.
IsInputChar (inherited from Control) | Determines if a character is an input character that the control recognizes.
IsInputKey (inherited from Control) | Determines whether the specified key is a regular input key or a special key that requires preprocessing.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
NotifyInvalidate (inherited from Control) |
OnActivated (inherited from Form) | Raises the Activated event.
OnBackColorChanged (inherited from Control) | Raises the BackColorChanged event.
OnBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event.
OnBindingContextChanged (inherited from Control) | Raises the BindingContextChangedevent.
OnCausesValidationChanged (inherited from Control) | Raises the CausesValidationChangedevent.
OnChangeUICues (inherited from Control) | Raises the ChangeUICues event.
OnClick (inherited from Control) | Raises the Click event.
OnClosed (inherited from Form) | Raises the Closed event.
OnClosing (inherited from Form) | Raises the Closing event.
OnContextMenuChanged (inherited from Control) | Raises the ContextMenuChangedevent.
OnControlAdded (inherited from Control) | Raises the ControlAdded event.
OnControlRemoved (inherited from ContainerControl) |
OnCreateControl (inherited from Form) |
OnCursorChanged (inherited from Control) | Raises the CursorChangedevent.
OnDeactivate (inherited from Form) | Raises the Deactivate event.
OnDockChanged (inherited from Control) | Raises the DockChangedevent.
OnDoubleClick (inherited from Control) | Raises the DoubleClick event.
OnDragDrop (inherited from Control) | Raises the DragDrop event.
OnDragEnter (inherited from Control) | Raises the DragEnter event.
OnDragLeave (inherited from Control) | Raises the DragLeave event.
OnDragOver (inherited from Control) | Raises the DragOver event.
OnEnabledChanged (inherited from Control) | Raises the EnabledChanged event.
OnEnter (inherited from Control) | Raises the Enter event.
OnFontChanged (inherited from Form) |
OnForeColorChanged (inherited from Control) | Raises the ForeColorChangedevent.
OnGiveFeedback (inherited from Control) | Raises the GiveFeedback event.
OnGotFocus (inherited from Control) | Raises the GotFocus event.
OnHandleCreated (inherited from Form) |
OnHandleDestroyed (inherited from Form) |
OnHelpRequested (inherited from Control) | Raises the HelpRequested event.
OnImeModeChanged (inherited from Control) | Raises the ImeModeChanged event.
OnInputLanguageChanged (inherited from Form) | Raises the InputLanguageChanged event.
OnInputLanguageChanging (inherited from Form) | Raises the InputLanguageChanging event.
OnInvalidated (inherited from Control) | Raises the Invalidated event.
OnKeyDown (inherited from Control) | Raises the KeyDown event.
OnKeyPress (inherited from Control) | Raises the KeyPress event.
OnKeyUp (inherited from Control) | Raises the KeyUp event.
OnLayout (inherited from ScrollableControl) |
OnLeave (inherited from Control) | Raises the Leave event.
OnLoad (inherited from Form) | Raises the Load event.
OnLocationChanged (inherited from Control) | Raises the LocationChanged event.
OnLostFocus (inherited from Control) | Raises the LostFocus event.
OnMaximizedBoundsChanged (inherited from Form) | Raises the MaximizedBoundsChanged event.
OnMaximumSizeChanged (inherited from Form) | Raises the MaximumSizeChanged event.
OnMdiChildActivate (inherited from Form) | Raises the MdiChildActivate event.
OnMenuComplete (inherited from Form) | Raises the MenuComplete event.
OnMenuStart (inherited from Form) | Raises the MenuStart event.
OnMinimumSizeChanged (inherited from Form) | Raises the MinimumSizeChanged event.
OnMouseDown (inherited from Control) | Raises the MouseDown event.
OnMouseEnter (inherited from Control) | Raises the MouseEnter event.
OnMouseHover (inherited from Control) | Raises the MouseHover event.
OnMouseLeave (inherited from Control) | Raises the MouseLeave event.
OnMouseMove (inherited from Control) | Raises the MouseMove event.
OnMouseUp (inherited from Control) | Raises the MouseUp event.
OnMouseWheel (inherited from ScrollableControl) |
OnMove (inherited from Control) | Raises the Move event.
OnNotifyMessage (inherited from Control) | Notifies the control of Windows messages.
OnPaint (inherited from Form) |
OnPaintBackground (inherited from Control) | Paints the background of the control.
OnParentBackColorChanged (inherited from Control) | Raises the BackColorChanged event when the BackColor property value of the control's container changes.
OnParentBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes.
OnParentBindingContextChanged (inherited from Control) | Raises the BindingContextChanged event when the BindingContext property value of the control's container changes.
OnParentChanged (inherited from Control) | Raises the ParentChanged event.
OnParentEnabledChanged (inherited from Control) | Raises the EnabledChanged event when the Enabled property value of the control's container changes.
OnParentFontChanged (inherited from Control) | Raises the FontChanged event when the Font property value of the control's container changes.
OnParentForeColorChanged (inherited from Control) | Raises the ForeColorChanged event when the ForeColor property value of the control's container changes.
OnParentRightToLeftChanged (inherited from Control) | Raises the RightToLeftChanged event when the RightToLeft property value of the control's container changes.
OnParentVisibleChanged (inherited from Control) | Raises the VisibleChanged event when the Visible property value of the control's container changes.
OnQueryContinueDrag (inherited from Control) | Raises the QueryContinueDrag event.
OnResize (inherited from Form) |
OnRightToLeftChanged (inherited from Control) | Raises the RightToLeftChangedevent.
OnSizeChanged (inherited from Control) | Raises the SizeChanged event.
OnStyleChanged (inherited from Form) |
OnSystemColorsChanged (inherited from Control) | Raises the SystemColorsChanged event.
OnTabIndexChanged (inherited from Control) | Raises the TabIndexChanged event.
OnTabStopChanged (inherited from Control) | Raises the TabStopChanged event.
OnTextChanged (inherited from Form) |
OnValidated (inherited from Control) | Raises the Validated event.
OnValidating (inherited from Control) | Raises the Validating event.
OnVisibleChanged (inherited from Form) |
ProcessCmdKey (inherited from Form) |
ProcessDialogChar (inherited from ContainerControl) |
ProcessDialogKey (inherited from Form) |
ProcessKeyEventArgs (inherited from Control) | Processes a key message and generates the appropriate control events.
ProcessKeyPreview (inherited from Form) |
ProcessMnemonic (inherited from ContainerControl) |
ProcessTabKey (inherited from Form) |
RaiseDragEvent (inherited from Control) |
RaiseKeyEvent (inherited from Control) |
RaiseMouseEvent (inherited from Control) |
RaisePaintEvent (inherited from Control) |
RecreateHandle (inherited from Control) | Forces the re-creation of the handle for the control.
ResetMouseEventArgs (inherited from Control) |
RtlTranslateAlignment (inherited from Control) | Overloaded. Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateContent (inherited from Control) | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
RtlTranslateHorizontal (inherited from Control) | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateLeftRight (inherited from Control) | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
ScaleCore (inherited from Form) |
Select (inherited from Form) | Overloaded.
SetBoundsCore (inherited from Form) |
SetClientSizeCore (inherited from Form) |
SetDisplayRectLocation (inherited from ScrollableControl) |
SetScrollState (inherited from ScrollableControl) |
SetStyle (inherited from Control) | Sets the specified style bit to the specified value.
SetTopLevel (inherited from Control) | Sets the control as the top-level control.
SetVisibleCore (inherited from Form) |
UpdateBounds (inherited from Control) | Overloaded. Updates the bounds of the control with the current size and location.
UpdateDefaultButton (inherited from Form) |
UpdateStyles (inherited from Control) | Forces the assigned styles to be reapplied to the control.
UpdateZOrder (inherited from Control) | Updates the control in its parent's z-order.
WndProc (inherited from Form) |

Protected Internal Instance Methods

ProcessKeyMessage (inherited from Control) Processes a keyboard message.

Explicit Interface Implementations

IContainerControl.ActivateControl (inherited from ContainerControl)

See Also

AttributesForm Class | NDoc.Core Namespace


AttributesForm Constructor

Creates and initialize a new AttributesForm object.

public AttributesForm(
object val
);

Parameters

val

See Also

AttributesForm Class | NDoc.Core Namespace


AttributesForm Fields

The fields of the AttributesForm class are listed below. For a complete list of AttributesForm class members, see the AttributesForm Members topic.

Public Instance Fields

Value Contains the updated value, if the user clicked OK.

See Also

AttributesForm Class | NDoc.Core Namespace


AttributesForm.Value Field

Contains the updated value, if the user clicked OK.

public string Value;

See Also

AttributesForm Class | NDoc.Core Namespace


AttributesForm Methods

The methods of the AttributesForm class are listed below. For a complete list of AttributesForm class members, see the AttributesForm Members topic.

Public Instance Methods

Activate (inherited from Form) | Activates the form and gives it focus.
AddOwnedForm (inherited from Form) | Adds an owned form to this form.
BeginInvoke (inherited from Control) | Overloaded. Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
BringToFront (inherited from Control) | Brings the control to the front of the z-order.
Close (inherited from Form) | Closes the form.
Contains (inherited from Control) | Retrieves a value indicating whether the specified control is a child of the control.
CreateControl (inherited from Control) | Forces the creation of the control, including the creation of the handle and any child controls.
CreateGraphics (inherited from Control) | Creates the Graphics object for the control.
CreateObjRef (inherited from MarshalByRefObject) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose (inherited from Component) | Overloaded. Releases all resources used by the Component.
DoDragDrop (inherited from Control) | Begins a drag-and-drop operation.
EndInvoke (inherited from Control) | Retrieves the return value of the asynchronous operation represented by the IAsyncResult object passed.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
FindForm (inherited from Control) | Retrieves the form that the control is on.
Focus (inherited from Control) | Sets input focus to the control.
GetChildAtPoint (inherited from Control) | Retrieves the child control that is located at the specified coordinates.
GetContainerControl (inherited from Control) | Returns the next ContainerControl up the control's chain of parent controls.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) | Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetNextControl (inherited from Control) | Retrieves the next control forward or back in the tab order of child controls.
GetType (inherited from Object) | Gets the Type of the current instance.
Hide (inherited from Control) | Conceals the control from the user.
InitializeLifetimeService (inherited from MarshalByRefObject) | Obtains a lifetime service object to control the lifetime policy for this instance.
Invalidate (inherited from Control) | Overloaded. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
Invoke (inherited from Control) | Overloaded. Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
LayoutMdi (inherited from Form) | Arranges the multiple document interface (MDI) child forms within the MDI parent form.
PerformLayout (inherited from Control) | Overloaded. Forces the control to apply layout logic to all its child controls.
PointToClient (inherited from Control) | Computes the location of the specified screen point into client coordinates.
PointToScreen (inherited from Control) | Computes the location of the specified client point into screen coordinates.
PreProcessMessage (inherited from Control) | Preprocesses input messages within the message loop before they are dispatched.
RectangleToClient (inherited from Control) | Computes the size and location of the specified screen rectangle in client coordinates.
RectangleToScreen (inherited from Control) | Computes the size and location of the specified client rectangle in screen coordinates.
Refresh (inherited from Control) | Forces the control to invalidate its client area and immediately redraw itself and any child controls.
RemoveOwnedForm (inherited from Form) | Removes an owned form from this form.
ResetBackColor (inherited from Control) | Resets the BackColor property to its default value.
ResetBindings (inherited from Control) | Resets the DataBindings property to its default value.
ResetCursor (inherited from Control) | Resets the Cursor property to its default value.
ResetFont (inherited from Control) | Resets the Fontproperty to its default value.
ResetForeColor (inherited from Control) | Resets the ForeColor property to its default value.
ResetImeMode (inherited from Control) | Resets the ImeMode property to its default value.
ResetRightToLeft (inherited from Control) | Resets the RightToLeft property to its default value.
ResetText (inherited from Control) | Resets the Text property to its default value.
ResumeLayout (inherited from Control) | Overloaded. Resumes normal layout logic.
Scale (inherited from Control) | Overloaded. Scales the control and any child controls to the specified ratio.
ScrollControlIntoView (inherited from ScrollableControl) |
Select (inherited from Control) | Overloaded. Activates the control.
SelectNextControl (inherited from Control) | Activates the next control.
SendToBack (inherited from Control) | Sends the control to the back of the z-order.
SetAutoScrollMargin (inherited from ScrollableControl) | Sets the size of the auto-scroll margins.
SetBounds (inherited from Control) | Overloaded. Sets the bounds of the control to the specified location and size.
SetDesktopBounds (inherited from Form) | Sets the bounds of the form in desktop coordinates.
SetDesktopLocation (inherited from Form) | Sets the location of the form in desktop coordinates.
Show (inherited from Control) | Displays the control to the user.
ShowDialog (inherited from Form) | Overloaded. Shows the form as a modal dialog box with no owner window.
SuspendLayout (inherited from Control) | Temporarily suspends the layout logic for the control.
ToString (inherited from Form) |
Update (inherited from Control) | Causes the control to redraw the invalidated regions within its client area.
Validate (inherited from ContainerControl) | Validates the last invalidated control and its ancestors up through, but not including, the current control.

Protected Instance Methods

AccessibilityNotifyClients (inherited from Control) | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control.
ActivateMdiChild (inherited from Form) |
AdjustFormScrollbars (inherited from Form) |
ApplyAutoScaling (inherited from Form) |
CenterToParent (inherited from Form) |
CenterToScreen (inherited from Form) |
CreateAccessibilityInstance (inherited from Control) | Creates a new accessibility object for the control.
CreateControlsInstance (inherited from Form) |
CreateHandle (inherited from Form) |
DefWndProc (inherited from Form) |
DestroyHandle (inherited from Control) | Destroys the handle associated with the control.
Dispose | Overloaded. Clean up any resources being used.
Finalize (inherited from Component) | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
GetScrollState (inherited from ScrollableControl) |
GetService (inherited from Component) | Returns an object that represents a service provided by the Component or by its Container.
GetStyle (inherited from Control) | Retrieves the value of the specified control style bit for the control.
GetTopLevel (inherited from Control) | Determines if the control is a top-level control.
InitLayout (inherited from Control) | Called after the control has been added to another container.
InvokeGotFocus (inherited from Control) | Raises the GotFocus event for the specified control.
InvokeLostFocus (inherited from Control) | Raises the LostFocus event for the specified control.
InvokeOnClick (inherited from Control) | Raises the Click event for the specified control.
InvokePaint (inherited from Control) | Raises the Paint event for the specified control.
InvokePaintBackground (inherited from Control) | Raises the PaintBackground event for the specified control.
IsInputChar (inherited from Control) | Determines if a character is an input character that the control recognizes.
IsInputKey (inherited from Control) | Determines whether the specified key is a regular input key or a special key that requires preprocessing.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
NotifyInvalidate (inherited from Control) |
OnActivated (inherited from Form) | Raises the Activated event.
OnBackColorChanged (inherited from Control) | Raises the BackColorChanged event.
OnBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event.
OnBindingContextChanged (inherited from Control) | Raises the BindingContextChangedevent.
OnCausesValidationChanged (inherited from Control) | Raises the CausesValidationChangedevent.
OnChangeUICues (inherited from Control) | Raises the ChangeUICues event.
OnClick (inherited from Control) | Raises the Click event.
OnClosed (inherited from Form) | Raises the Closed event.
OnClosing (inherited from Form) | Raises the Closing event.
OnContextMenuChanged (inherited from Control) | Raises the ContextMenuChangedevent.
OnControlAdded (inherited from Control) | Raises the ControlAdded event.
OnControlRemoved (inherited from ContainerControl) |
OnCreateControl (inherited from Form) |
OnCursorChanged (inherited from Control) | Raises the CursorChangedevent.
OnDeactivate (inherited from Form) | Raises the Deactivate event.
OnDockChanged (inherited from Control) | Raises the DockChangedevent.
OnDoubleClick (inherited from Control) | Raises the DoubleClick event.
OnDragDrop (inherited from Control) | Raises the DragDrop event.
OnDragEnter (inherited from Control) | Raises the DragEnter event.
OnDragLeave (inherited from Control) | Raises the DragLeave event.
OnDragOver (inherited from Control) | Raises the DragOver event.
OnEnabledChanged (inherited from Control) | Raises the EnabledChanged event.
OnEnter (inherited from Control) | Raises the Enter event.
OnFontChanged (inherited from Form) |
OnForeColorChanged (inherited from Control) | Raises the ForeColorChangedevent.
OnGiveFeedback (inherited from Control) | Raises the GiveFeedback event.
OnGotFocus (inherited from Control) | Raises the GotFocus event.
OnHandleCreated (inherited from Form) |
OnHandleDestroyed (inherited from Form) |
OnHelpRequested (inherited from Control) | Raises the HelpRequested event.
OnImeModeChanged (inherited from Control) | Raises the ImeModeChanged event.
OnInputLanguageChanged (inherited from Form) | Raises the InputLanguageChanged event.
OnInputLanguageChanging (inherited from Form) | Raises the InputLanguageChanging event.
OnInvalidated (inherited from Control) | Raises the Invalidated event.
OnKeyDown (inherited from Control) | Raises the KeyDown event.
OnKeyPress (inherited from Control) | Raises the KeyPress event.
OnKeyUp (inherited from Control) | Raises the KeyUp event.
OnLayout (inherited from ScrollableControl) |
OnLeave (inherited from Control) | Raises the Leave event.
OnLoad (inherited from Form) | Raises the Load event.
OnLocationChanged (inherited from Control) | Raises the LocationChanged event.
OnLostFocus (inherited from Control) | Raises the LostFocus event.
OnMaximizedBoundsChanged (inherited from Form) | Raises the MaximizedBoundsChanged event.
OnMaximumSizeChanged (inherited from Form) | Raises the MaximumSizeChanged event.
OnMdiChildActivate (inherited from Form) | Raises the MdiChildActivate event.
OnMenuComplete (inherited from Form) | Raises the MenuComplete event.
OnMenuStart (inherited from Form) | Raises the MenuStart event.
OnMinimumSizeChanged (inherited from Form) | Raises the MinimumSizeChanged event.
OnMouseDown (inherited from Control) | Raises the MouseDown event.
OnMouseEnter (inherited from Control) | Raises the MouseEnter event.
OnMouseHover (inherited from Control) | Raises the MouseHover event.
OnMouseLeave (inherited from Control) | Raises the MouseLeave event.
OnMouseMove (inherited from Control) | Raises the MouseMove event.
OnMouseUp (inherited from Control) | Raises the MouseUp event.
OnMouseWheel (inherited from ScrollableControl) |
OnMove (inherited from Control) | Raises the Move event.
OnNotifyMessage (inherited from Control) | Notifies the control of Windows messages.
OnPaint (inherited from Form) |
OnPaintBackground (inherited from Control) | Paints the background of the control.
OnParentBackColorChanged (inherited from Control) | Raises the BackColorChanged event when the BackColor property value of the control's container changes.
OnParentBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes.
OnParentBindingContextChanged (inherited from Control) | Raises the BindingContextChanged event when the BindingContext property value of the control's container changes.
OnParentChanged (inherited from Control) | Raises the ParentChanged event.
OnParentEnabledChanged (inherited from Control) | Raises the EnabledChanged event when the Enabled property value of the control's container changes.
OnParentFontChanged (inherited from Control) | Raises the FontChanged event when the Font property value of the control's container changes.
OnParentForeColorChanged (inherited from Control) | Raises the ForeColorChanged event when the ForeColor property value of the control's container changes.
OnParentRightToLeftChanged (inherited from Control) | Raises the RightToLeftChanged event when the RightToLeft property value of the control's container changes.
OnParentVisibleChanged (inherited from Control) | Raises the VisibleChanged event when the Visible property value of the control's container changes.
OnQueryContinueDrag (inherited from Control) | Raises the QueryContinueDrag event.
OnResize (inherited from Form) |
OnRightToLeftChanged (inherited from Control) | Raises the RightToLeftChangedevent.
OnSizeChanged (inherited from Control) | Raises the SizeChanged event.
OnStyleChanged (inherited from Form) |
OnSystemColorsChanged (inherited from Control) | Raises the SystemColorsChanged event.
OnTabIndexChanged (inherited from Control) | Raises the TabIndexChanged event.
OnTabStopChanged (inherited from Control) | Raises the TabStopChanged event.
OnTextChanged (inherited from Form) |
OnValidated (inherited from Control) | Raises the Validated event.
OnValidating (inherited from Control) | Raises the Validating event.
OnVisibleChanged (inherited from Form) |
ProcessCmdKey (inherited from Form) |
ProcessDialogChar (inherited from ContainerControl) |
ProcessDialogKey (inherited from Form) |
ProcessKeyEventArgs (inherited from Control) | Processes a key message and generates the appropriate control events.
ProcessKeyPreview (inherited from Form) |
ProcessMnemonic (inherited from ContainerControl) |
ProcessTabKey (inherited from Form) |
RaiseDragEvent (inherited from Control) |
RaiseKeyEvent (inherited from Control) |
RaiseMouseEvent (inherited from Control) |
RaisePaintEvent (inherited from Control) |
RecreateHandle (inherited from Control) | Forces the re-creation of the handle for the control.
ResetMouseEventArgs (inherited from Control) |
RtlTranslateAlignment (inherited from Control) | Overloaded. Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateContent (inherited from Control) | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
RtlTranslateHorizontal (inherited from Control) | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateLeftRight (inherited from Control) | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
ScaleCore (inherited from Form) |
Select (inherited from Form) | Overloaded.
SetBoundsCore (inherited from Form) |
SetClientSizeCore (inherited from Form) |
SetDisplayRectLocation (inherited from ScrollableControl) |
SetScrollState (inherited from ScrollableControl) |
SetStyle (inherited from Control) | Sets the specified style bit to the specified value.
SetTopLevel (inherited from Control) | Sets the control as the top-level control.
SetVisibleCore (inherited from Form) |
UpdateBounds (inherited from Control) | Overloaded. Updates the bounds of the control with the current size and location.
UpdateDefaultButton (inherited from Form) |
UpdateStyles (inherited from Control) | Forces the assigned styles to be reapplied to the control.
UpdateZOrder (inherited from Control) | Updates the control in its parent's z-order.
WndProc (inherited from Form) |

Protected Internal Instance Methods

ProcessKeyMessage (inherited from Control) Processes a keyboard message.

Explicit Interface Implementations

IContainerControl.ActivateControl (inherited from ContainerControl)

See Also

AttributesForm Class | NDoc.Core Namespace


Dispose Method

NDoc Documentation

AttributesForm.Dispose Method

Clean up any resources being used.

Overload List

Inherited from Component.

public void Dispose();

Clean up any resources being used.

protected override void Dispose(bool);

See Also

AttributesForm Class | NDoc.Core Namespace


AttributesForm.Dispose Method (Boolean)

Clean up any resources being used.

protected override void Dispose(
bool disposing
);

See Also

AttributesForm Class | NDoc.Core Namespace | AttributesForm.Dispose Overload List


AttributeToShow Class

Class which holds information about an attribute.

For a list of all members of this type, see AttributeToShow Members.

System.Object
AttributeToShow

public class AttributeToShow

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

AttributeToShow Members | NDoc.Core Namespace


AttributeToShow Members

AttributeToShow overview

Public Instance Constructors

AttributeToShow Constructor Creates an empty AttributeToShow object

Public Instance Fields

PropertiesToShow List of properties

Public Instance Properties

Name Name attribute

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

AttributeToShow Class | NDoc.Core Namespace


AttributeToShow Constructor

Creates an empty AttributeToShow object

public AttributeToShow();

See Also

AttributeToShow Class | NDoc.Core Namespace


AttributeToShow Fields

The fields of the AttributeToShow class are listed below. For a complete list of AttributeToShow class members, see the AttributeToShow Members topic.

Public Instance Fields

PropertiesToShow List of properties

See Also

AttributeToShow Class | NDoc.Core Namespace


AttributeToShow.PropertiesToShow Field

List of properties

public ArrayList PropertiesToShow;

See Also

AttributeToShow Class | NDoc.Core Namespace


AttributeToShow Properties

The properties of the AttributeToShow class are listed below. For a complete list of AttributeToShow class members, see the AttributeToShow Members topic.

Public Instance Properties

Name Name attribute

See Also

AttributeToShow Class | NDoc.Core Namespace


AttributeToShow.Name Property

Name attribute

public string Name {get; set;}

See Also

AttributeToShow Class | NDoc.Core Namespace


BaseDocumenter Class

Provides the base class for documenters.

For a list of all members of this type, see BaseDocumenter Members.

System.Object
BaseDocumenter

public abstract class BaseDocumenter : IDocumenter, IComparable

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

BaseDocumenter Members | NDoc.Core Namespace


BaseDocumenter Members

BaseDocumenter overview

Public Static Methods

LoadAssembly Loads an assembly.

Public Instance Properties

Config | See IDocumenter.
DevelopmentStatus | The development status (alpha, beta, stable) of this documenter. Documenters should override this if they aren't stable.
MainOutputFile | See IDocumenter.
Name | Gets the display name for the documenter.

Public Instance Methods

Build | See IDocumenter.
CanBuild | Overloaded. See IDocumenter.
Clear | See IDocumenter.
CompareTo | Compares the currrent document to another documenter.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Object) | Returns a String that represents the current Object.
View | See IDocumenter.

Public Instance Events

DocBuildingProgress | See IDocumenter.
DocBuildingStep | See IDocumenter.

Protected Instance Constructors

BaseDocumenter Constructor Initialized a new BaseDocumenter instance.

Protected Instance Properties

Document | Gets the XmlDocument containing the combined relected metadata and /doc comments.
XmlBuffer | The XML string containing the combined relected metadata and /doc comments.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetXPathDocument | Returns the XPathDocument to access the combined relected metadata and /doc comments.
MakeXml | Builds an XmlDocument combining the reflected metadata with the /doc comments.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
OnDocBuildingProgress | Raises the DocBuildingProgress event.
OnDocBuildingStep | Raises the DocBuildingStep event.
SetupAssemblyResolver | Setup AssemblyResolver for case where system doesn't resolve an assembly automatically. This puts in the directories in ReferencesPath, and the directories to each assembly referenced in the project.

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter Constructor

Initialized a new BaseDocumenter instance.

protected BaseDocumenter(
string name
);

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter Properties

The properties of the BaseDocumenter class are listed below. For a complete list of BaseDocumenter class members, see the BaseDocumenter Members topic.

Public Instance Properties

Config | See IDocumenter.
DevelopmentStatus | The development status (alpha, beta, stable) of this documenter. Documenters should override this if they aren't stable.
MainOutputFile | See IDocumenter.
Name | Gets the display name for the documenter.

Protected Instance Properties

Document | Gets the XmlDocument containing the combined relected metadata and /doc comments.
XmlBuffer | The XML string containing the combined relected metadata and /doc comments.

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.Config Property

See IDocumenter.

public IDocumenterConfig Config {get; set;}

Implements

IDocumenter.Config

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.DevelopmentStatus Property

The development status (alpha, beta, stable) of this documenter. Documenters should override this if they aren't stable.

public virtual DocumenterDevelopmentStatus DevelopmentStatus {get;}

Implements

IDocumenter.DevelopmentStatus

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.Document Property

Gets the XmlDocument containing the combined relected metadata and /doc comments.

protected System.Xml.XmlDocument Document {get;}

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.MainOutputFile Property

See IDocumenter.

public abstract string MainOutputFile {get;}

Implements

IDocumenter.MainOutputFile

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.Name Property

Gets the display name for the documenter.

public string Name {get;}

Implements

IDocumenter.Name

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.XmlBuffer Property

The XML string containing the combined relected metadata and /doc comments.

protected string XmlBuffer {get;}

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter Methods

The methods of the BaseDocumenter class are listed below. For a complete list of BaseDocumenter class members, see the BaseDocumenter Members topic.

Public Static Methods

LoadAssembly Loads an assembly.

Public Instance Methods

Build | See IDocumenter.
CanBuild | Overloaded. See IDocumenter.
Clear | See IDocumenter.
CompareTo | Compares the currrent document to another documenter.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Object) | Returns a String that represents the current Object.
View | See IDocumenter.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetXPathDocument | Returns the XPathDocument to access the combined relected metadata and /doc comments.
MakeXml | Builds an XmlDocument combining the reflected metadata with the /doc comments.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
OnDocBuildingProgress | Raises the DocBuildingProgress event.
OnDocBuildingStep | Raises the DocBuildingStep event.
SetupAssemblyResolver | Setup AssemblyResolver for case where system doesn't resolve an assembly automatically. This puts in the directories in ReferencesPath, and the directories to each assembly referenced in the project.

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.Build Method

See IDocumenter.

public abstract void Build(
Project project
);

Implements

IDocumenter.Build

See Also

BaseDocumenter Class | NDoc.Core Namespace


CanBuild Method

NDoc Documentation

BaseDocumenter.CanBuild Method

See IDocumenter.

Overload List

See IDocumenter.

public virtual string CanBuild(Project);

See IDocumenter.

public virtual string CanBuild(Project,bool);

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.CanBuild Method (Project)

See IDocumenter.

public virtual string CanBuild(
Project project
);

Implements

IDocumenter.CanBuild

See Also

BaseDocumenter Class | NDoc.Core Namespace | BaseDocumenter.CanBuild Overload List


BaseDocumenter.CanBuild Method (Project, Boolean)

See IDocumenter.

public virtual string CanBuild(
Project project,
bool checkInputOnly
);

Implements

IDocumenter.CanBuild

See Also

BaseDocumenter Class | NDoc.Core Namespace | BaseDocumenter.CanBuild Overload List


BaseDocumenter.Clear Method

See IDocumenter.

public abstract void Clear();

Implements

IDocumenter.Clear

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.CompareTo Method

Compares the currrent document to another documenter.

public int CompareTo(
object obj
);

Implements

IComparable.CompareTo

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.GetXPathDocument Method

Returns the XPathDocument to access the combined relected metadata and /doc comments.

protected XPathDocument GetXPathDocument();

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.LoadAssembly Method

Loads an assembly.

public static Assembly LoadAssembly(
string fileName
);

Parameters

fileName
The assembly filename.

Return Value

The assembly object.

Remarks

This method loads an assembly into memory. If you use Assembly.Load or Assembly.LoadFrom the assembly file locks. This method doesn't lock the assembly file.

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.MakeXml Method

Builds an XmlDocument combining the reflected metadata with the /doc comments.

protected void MakeXml(
Project project
);

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.OnDocBuildingProgress Method

Raises the DocBuildingProgress event.

protected void OnDocBuildingProgress(
int progress
);

Parameters

progress
Percentage progress value

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.OnDocBuildingStep Method

Raises the DocBuildingStep event.

protected void OnDocBuildingStep(
int step,
string label
);

Parameters

step
The overall percent complete value.
label
A description of the work currently beeing done.

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.SetupAssemblyResolver Method

Setup AssemblyResolver for case where system doesn't resolve an assembly automatically. This puts in the directories in ReferencesPath, and the directories to each assembly referenced in the project.

protected AssemblyResolver SetupAssemblyResolver(
Project project
);

Parameters

project

Remarks

The case which forced this to be so thorough is when an assembly references an unmanaged (native) dll. When the assembly is loaded, the system must also find the unmanaged dll. The rules for finding the unmanaged dll are apparently just like any other application: current working directory, the path environment variable, etc.

So in order to handle that case, we have to install an AssemblyResolver that catches the resolution failure, and uses an assembly load function that cd's to the directory which hopefully contains the unmanaged dll (see LoadAssembly()). So in this case I'm assuming that the directory containing the referencing assembly also contains the unmanaged dll.

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.View Method

See IDocumenter.

public virtual void View();

Implements

IDocumenter.View

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter Events

The events of the BaseDocumenter class are listed below. For a complete list of BaseDocumenter class members, see the BaseDocumenter Members topic.

Public Instance Events

DocBuildingProgress | See IDocumenter.
DocBuildingStep | See IDocumenter.

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.DocBuildingProgress Event

See IDocumenter.

public event DocBuildingEventHandler DocBuildingProgress;

Implements

IDocumenter.DocBuildingProgress

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenter.DocBuildingStep Event

See IDocumenter.

public event DocBuildingEventHandler DocBuildingStep;

Implements

IDocumenter.DocBuildingStep

See Also

BaseDocumenter Class | NDoc.Core Namespace


BaseDocumenterConfig Class

The base documenter config class.

For a list of all members of this type, see BaseDocumenterConfig Members.

System.Object
BaseDocumenterConfig

public abstract class BaseDocumenterConfig : IDocumenterConfig

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

BaseDocumenterConfig Members | NDoc.Core Namespace


BaseDocumenterConfig Members

BaseDocumenterConfig overview

Public Instance Constructors

BaseDocumenterConfig Constructor Initializes a new instance of the DocumenterConfig class.

Public Instance Properties

AutoDocumentConstructors | Gets or sets the AutoDocumentConstructors property.
AutoPropertyBackerSummaries | Gets or sets the AutoPropertyBackerSummaries property.
CopyrightHref | Gets or sets the CopyrightHref property.
CopyrightText | Gets or sets the CopyrightText property.
DocumentAttributes | Gets or sets whether or not to document the attributes.
DocumentedAttributes | Gets or sets which attributes should be documented.
DocumentEmptyNamespaces | Gets or sets the DocumentPrivates property.
DocumentInternals | Gets or sets the DocumentInternals property.
DocumentPrivates | Gets or sets the DocumentPrivates property.
DocumentProtected | Gets or sets the DocumentProtected property.
DocumentProtectedInternalAsProtected | Gets or sets the DocumentProtectedInternalAsProtected property.
EditorBrowsableFilter | Specifies the level of filtering on the EditorBrowsable attribute.
GetExternalSummaries | Load external xml files?
IncludeAssemblyVersion | Gets or sets the IncludeAssemblyVersion property.
ReferencesPath | Gets or sets the base directory used to resolve directory and assembly references.
ShowMissingParams | Gets or sets the ShowMissingParams property.
ShowMissingRemarks | Gets or sets the ShowMissingRemarks property.
ShowMissingReturns | Gets or sets the ShowMissingReturns property.
ShowMissingSummaries | Gets or sets the ShowMissingSummaries property.
ShowMissingValues | Gets or sets the ShowMissingValues property.
ShowTypeIdInAttributes | Gets or sets whether or not to show the TypeId property in attributes.
SkipNamespacesWithoutSummaries | Gets or sets the SkipNamespacesWithoutSummaries property.
UseNamespaceDocSummaries | Gets or sets the UseNamespaceDocSummaries property.
UseNDocXmlFile | Gets or sets the UseNDocXmlFile property.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetProperties | Gets a list of property names.
GetType (inherited from Object) | Gets the Type of the current instance.
Read | Reads the previously serialized state of the documenter into memory.
SetProject | Associates this documenter with a project;
SetValue | Sets the value of a property.
ToString (inherited from Object) | Returns a String that represents the current Object.
Write | Writes the current state of the documenter to the specified XmlWrtier.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
SetDirty | Sets the IsDirty property on the project if any is set.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig Constructor

Initializes a new instance of the DocumenterConfig class.

public BaseDocumenterConfig(
string name
);

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig Properties

The properties of the BaseDocumenterConfig class are listed below. For a complete list of BaseDocumenterConfig class members, see the BaseDocumenterConfig Members topic.

Public Instance Properties

AutoDocumentConstructors | Gets or sets the AutoDocumentConstructors property.
AutoPropertyBackerSummaries | Gets or sets the AutoPropertyBackerSummaries property.
CopyrightHref | Gets or sets the CopyrightHref property.
CopyrightText | Gets or sets the CopyrightText property.
DocumentAttributes | Gets or sets whether or not to document the attributes.
DocumentedAttributes | Gets or sets which attributes should be documented.
DocumentEmptyNamespaces | Gets or sets the DocumentPrivates property.
DocumentInternals | Gets or sets the DocumentInternals property.
DocumentPrivates | Gets or sets the DocumentPrivates property.
DocumentProtected | Gets or sets the DocumentProtected property.
DocumentProtectedInternalAsProtected | Gets or sets the DocumentProtectedInternalAsProtected property.
EditorBrowsableFilter | Specifies the level of filtering on the EditorBrowsable attribute.
GetExternalSummaries | Load external xml files?
IncludeAssemblyVersion | Gets or sets the IncludeAssemblyVersion property.
ReferencesPath | Gets or sets the base directory used to resolve directory and assembly references.
ShowMissingParams | Gets or sets the ShowMissingParams property.
ShowMissingRemarks | Gets or sets the ShowMissingRemarks property.
ShowMissingReturns | Gets or sets the ShowMissingReturns property.
ShowMissingSummaries | Gets or sets the ShowMissingSummaries property.
ShowMissingValues | Gets or sets the ShowMissingValues property.
ShowTypeIdInAttributes | Gets or sets whether or not to show the TypeId property in attributes.
SkipNamespacesWithoutSummaries | Gets or sets the SkipNamespacesWithoutSummaries property.
UseNamespaceDocSummaries | Gets or sets the UseNamespaceDocSummaries property.
UseNDocXmlFile | Gets or sets the UseNDocXmlFile property.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.AutoDocumentConstructors Property

Gets or sets the AutoDocumentConstructors property.

public bool AutoDocumentConstructors {get; set;}

Remarks

If this is true, default constructors without /doc summary comments will be automatically documented.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.AutoPropertyBackerSummaries Property

Gets or sets the AutoPropertyBackerSummaries property.

public bool AutoPropertyBackerSummaries {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.CopyrightHref Property

Gets or sets the CopyrightHref property.

public string CopyrightHref {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.CopyrightText Property

Gets or sets the CopyrightText property.

public string CopyrightText {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.DocumentAttributes Property

Gets or sets whether or not to document the attributes.

public bool DocumentAttributes {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.DocumentedAttributes Property

Gets or sets which attributes should be documented.

public string DocumentedAttributes {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.DocumentEmptyNamespaces Property

Gets or sets the DocumentPrivates property.

public bool DocumentEmptyNamespaces {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.DocumentInternals Property

Gets or sets the DocumentInternals property.

public bool DocumentInternals {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.DocumentPrivates Property

Gets or sets the DocumentPrivates property.

public bool DocumentPrivates {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.DocumentProtected Property

Gets or sets the DocumentProtected property.

public bool DocumentProtected {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.DocumentProtectedInternalAsProtected Property

Gets or sets the DocumentProtectedInternalAsProtected property.

public bool DocumentProtectedInternalAsProtected {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.EditorBrowsableFilter Property

Specifies the level of filtering on the EditorBrowsable attribute.

public EditorBrowsableFilterLevel EditorBrowsableFilter {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.GetExternalSummaries Property

Load external xml files?

public bool GetExternalSummaries {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.IncludeAssemblyVersion Property

Gets or sets the IncludeAssemblyVersion property.

public bool IncludeAssemblyVersion {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.ReferencesPath Property

Gets or sets the base directory used to resolve directory and assembly references.

public string ReferencesPath {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.ShowMissingParams Property

Gets or sets the ShowMissingParams property.

public bool ShowMissingParams {get; set;}

Remarks

If this is true, all members without /doc summary comments will contain the phrase "Missing Documentation" in the generated documentation.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.ShowMissingRemarks Property

Gets or sets the ShowMissingRemarks property.

public bool ShowMissingRemarks {get; set;}

Remarks

If this is true, all members without /doc summary comments will contain the phrase "Missing Documentation" in the generated documentation.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.ShowMissingReturns Property

Gets or sets the ShowMissingReturns property.

public bool ShowMissingReturns {get; set;}

Remarks

If this is true, all members without /doc summary comments will contain the phrase "Missing Documentation" in the generated documentation.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.ShowMissingSummaries Property

Gets or sets the ShowMissingSummaries property.

public bool ShowMissingSummaries {get; set;}

Remarks

If this is true, all members without /doc summary comments will contain the phrase "Missing Documentation" in the generated documentation.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.ShowMissingValues Property

Gets or sets the ShowMissingValues property.

public bool ShowMissingValues {get; set;}

Remarks

If this is true, all members without /doc summary comments will contain the phrase "Missing Documentation" in the generated documentation.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.ShowTypeIdInAttributes Property

Gets or sets whether or not to show the TypeId property in attributes.

public bool ShowTypeIdInAttributes {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.SkipNamespacesWithoutSummaries Property

Gets or sets the SkipNamespacesWithoutSummaries property.

public bool SkipNamespacesWithoutSummaries {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.UseNamespaceDocSummaries Property

Gets or sets the UseNamespaceDocSummaries property.

public bool UseNamespaceDocSummaries {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.UseNDocXmlFile Property

Gets or sets the UseNDocXmlFile property.

public string UseNDocXmlFile {get; set;}

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig Methods

The methods of the BaseDocumenterConfig class are listed below. For a complete list of BaseDocumenterConfig class members, see the BaseDocumenterConfig Members topic.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetProperties | Gets a list of property names.
GetType (inherited from Object) | Gets the Type of the current instance.
Read | Reads the previously serialized state of the documenter into memory.
SetProject | Associates this documenter with a project;
SetValue | Sets the value of a property.
ToString (inherited from Object) | Returns a String that represents the current Object.
Write | Writes the current state of the documenter to the specified XmlWrtier.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
SetDirty | Sets the IsDirty property on the project if any is set.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.GetProperties Method

Gets a list of property names.

public IEnumerable GetProperties();

Implements

IDocumenterConfig.GetProperties

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.Read Method

Reads the previously serialized state of the documenter into memory.

public void Read(
XmlReader reader
);

Parameters

reader
An XmlReader positioned on a documenter element.

Implements

IDocumenterConfig.Read

Remarks

This method uses reflection to set all of the public properties in the documenter.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.SetDirty Method

Sets the IsDirty property on the project if any is set.

protected void SetDirty();

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.SetProject Method

Associates this documenter with a project;

public void SetProject(
Project project
);

Implements

IDocumenterConfig.SetProject

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.SetValue Method

Sets the value of a property.

public void SetValue(
string name,
string value
);

Implements

IDocumenterConfig.SetValue

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


BaseDocumenterConfig.Write Method

Writes the current state of the documenter to the specified XmlWrtier.

public void Write(
XmlWriter writer
);

Parameters

writer
An XmlWriter.

Implements

IDocumenterConfig.Write

Remarks

This method uses reflection to serialize all of the public properties in the documenter.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace


CouldNotLoadAllAssembliesException Class

This exception is thrown when one or more assemblies can not be loaded.

For a list of all members of this type, see CouldNotLoadAllAssembliesException Members.

System.Object
Exception
ApplicationException
CouldNotLoadAllAssembliesException

public class CouldNotLoadAllAssembliesException : ApplicationException

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

CouldNotLoadAllAssembliesException Members | NDoc.Core Namespace


CouldNotLoadAllAssembliesException Members

CouldNotLoadAllAssembliesException overview

Public Instance Constructors

CouldNotLoadAllAssembliesException Overloaded. Initializes a new instance of the CouldNotLoadAllAssembliesException class.

Public Instance Properties

HelpLink (inherited from Exception) | Gets or sets a link to the help file associated with this exception.
InnerException (inherited from Exception) | Gets the Exception instance that caused the current exception.
Message (inherited from Exception) | Gets a message that describes the current exception.
Source (inherited from Exception) | Gets or sets the name of the application or the object that causes the error.
StackTrace (inherited from Exception) | Gets a string representation of the frames on the call stack at the time the current exception was thrown.
TargetSite (inherited from Exception) | Gets the method that throws the current exception.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetBaseException (inherited from Exception) | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetObjectData (inherited from Exception) | When overridden in a derived class, sets the SerializationInfo with information about the exception.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Exception) | Creates and returns a string representation of the current exception.

Protected Instance Constructors

CouldNotLoadAllAssembliesException Overloaded. Initializes a new instance of the CouldNotLoadAllAssembliesException class.

Protected Instance Properties

HResult (inherited from Exception) Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

CouldNotLoadAllAssembliesException Class | NDoc.Core Namespace


CouldNotLoadAllAssembliesException Constructor

Initializes a new instance of the CouldNotLoadAllAssembliesException class.

Overload List

Initializes a new instance of the CouldNotLoadAllAssembliesException class.

public CouldNotLoadAllAssembliesException();

Missing <summary> documentation for M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)

protected CouldNotLoadAllAssembliesException(SerializationInfo,StreamingContext);

Missing <summary> documentation for M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor(System.String)

public CouldNotLoadAllAssembliesException(string);

Missing <summary> documentation for M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor(System.String,System.Exception)

public CouldNotLoadAllAssembliesException(string,Exception);

See Also

CouldNotLoadAllAssembliesException Class | NDoc.Core Namespace


CouldNotLoadAllAssembliesException Constructor ()

Initializes a new instance of the CouldNotLoadAllAssembliesException class.

public CouldNotLoadAllAssembliesException();

See Also

CouldNotLoadAllAssembliesException Class | NDoc.Core Namespace | CouldNotLoadAllAssembliesException Constructor Overload List


CouldNotLoadAllAssembliesException Constructor (String)

Missing <summary> documentation for M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor(System.String)

public CouldNotLoadAllAssembliesException(
string message
);

See Also

CouldNotLoadAllAssembliesException Class | NDoc.Core Namespace | CouldNotLoadAllAssembliesException Constructor Overload List


CouldNotLoadAllAssembliesException Constructor (String, Exception)

Missing <summary> documentation for M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor(System.String,System.Exception)

public CouldNotLoadAllAssembliesException(
string message,
Exception inner
);

See Also

CouldNotLoadAllAssembliesException Class | NDoc.Core Namespace | CouldNotLoadAllAssembliesException Constructor Overload List


CouldNotLoadAllAssembliesException Constructor (SerializationInfo, StreamingContext)

Missing <summary> documentation for M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)

protected CouldNotLoadAllAssembliesException(
SerializationInfo info,
StreamingContext context
);

See Also

CouldNotLoadAllAssembliesException Class | NDoc.Core Namespace | CouldNotLoadAllAssembliesException Constructor Overload List


DocBuildingEventHandler Delegate

Used by IDocumenter's events to notify doc building progress.

public delegate void DocBuildingEventHandler(
object sender,
ProgressArgs e
);

Parameters

sender
The source of the event.
e
An ProgressArgs that contains the event data.

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

NDoc.Core Namespace


DocumenterDevelopmentStatus Enumeration

This is used to indicate the development status of each documenter.

public enum DocumenterDevelopmentStatus

Members

Member Name | Description
Alpha | Still in development, not really ready for anyone else to use except to provide feedback.
Beta | Ready for users to try out, with the understanding that bugs are likely.
Stable | Ready for use, or at least as stable as free software gets!

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

NDoc.Core Namespace


DocumenterException Class

Represents the exceptions that are thrown when attempting to build documentation.

For a list of all members of this type, see DocumenterException Members.

System.Object
Exception
ApplicationException
DocumenterException

public class DocumenterException : ApplicationException

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

DocumenterException Members | NDoc.Core Namespace


DocumenterException Members

DocumenterException overview

Public Instance Constructors

DocumenterException Overloaded. Initializes a new instance of the DocumenterException class.

Public Instance Properties

HelpLink (inherited from Exception) | Gets or sets a link to the help file associated with this exception.
InnerException (inherited from Exception) | Gets the Exception instance that caused the current exception.
Message (inherited from Exception) | Gets a message that describes the current exception.
Source (inherited from Exception) | Gets or sets the name of the application or the object that causes the error.
StackTrace (inherited from Exception) | Gets a string representation of the frames on the call stack at the time the current exception was thrown.
TargetSite (inherited from Exception) | Gets the method that throws the current exception.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetBaseException (inherited from Exception) | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetObjectData (inherited from Exception) | When overridden in a derived class, sets the SerializationInfo with information about the exception.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Exception) | Creates and returns a string representation of the current exception.

Protected Instance Properties

HResult (inherited from Exception) Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

DocumenterException Class | NDoc.Core Namespace


DocumenterException Constructor

Initializes a new instance of the DocumenterException class with the specified message.

Overload List

Initializes a new instance of the DocumenterException class with the specified message.

public DocumenterException(string);

Initializes a new instance of the Exception class with a specified error message and a reference to the inner exception that is the root cause of this exception.

public DocumenterException(string,Exception);

See Also

DocumenterException Class | NDoc.Core Namespace


DocumenterException Constructor (String)

Initializes a new instance of the DocumenterException class with the specified message.

public DocumenterException(
string message
);

Parameters

message
The message to display when the exception is thrown.

See Also

DocumenterException Class | NDoc.Core Namespace | DocumenterException Constructor Overload List


DocumenterException Constructor (String, Exception)

Initializes a new instance of the Exception class with a specified error message and a reference to the inner exception that is the root cause of this exception.

public DocumenterException(
string message,
Exception inner
);

Parameters

message
The error message that explains the reason for the exception.
inner
An instance of Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.

See Also

DocumenterException Class | NDoc.Core Namespace | DocumenterException Constructor Overload List


EditorBrowsableFilterLevel Enumeration

Define the levels of filtering on the EditorBrowsable attribute.

public enum EditorBrowsableFilterLevel

Members

Member Name | Description
Off | No filtering.
HideNever | Hide members flagged with EditorBrowsableState.Never.
HideAdvanced | Hide members flagged with EditorBrowsableState.Never or EditorBrowsableState.Advanced.

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

NDoc.Core Namespace


EmbeddedResources Class

Utilties to help reading and writing embedded resources.

For a list of all members of this type, see EmbeddedResources Members.

System.Object
EmbeddedResources

public class EmbeddedResources

Remarks

This is used to access the stylesheets.

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

EmbeddedResources Members | NDoc.Core Namespace


EmbeddedResources Members

EmbeddedResources overview

Public Static Methods

WriteEmbeddedResource | Writes an embedded resource to disk.
WriteEmbeddedResources | Writes all the embedded resources with the specified prefix to disk.

Public Instance Constructors

EmbeddedResources Constructor Initializes a new instance of the EmbeddedResources class.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

EmbeddedResources Class | NDoc.Core Namespace


EmbeddedResources Constructor

Initializes a new instance of the EmbeddedResources class.

public EmbeddedResources();

See Also

EmbeddedResources Class | NDoc.Core Namespace


EmbeddedResources Methods

The methods of the EmbeddedResources class are listed below. For a complete list of EmbeddedResources class members, see the EmbeddedResources Members topic.

Public Static Methods

WriteEmbeddedResource | Writes an embedded resource to disk.
WriteEmbeddedResources | Writes all the embedded resources with the specified prefix to disk.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

EmbeddedResources Class | NDoc.Core Namespace


EmbeddedResources.WriteEmbeddedResource Method

Writes an embedded resource to disk.

public static void WriteEmbeddedResource(
Assembly assembly,
string name,
string directory,
string filename
);

Parameters

assembly
The assembly containing the embedded resource.
name
The name of the embedded resource.
directory
The directory to write the resource to.
filename
The filename of the resource on disk.

See Also

EmbeddedResources Class | NDoc.Core Namespace


EmbeddedResources.WriteEmbeddedResources Method

Writes all the embedded resources with the specified prefix to disk.

public static void WriteEmbeddedResources(
Assembly assembly,
string prefix,
string directory
);

Parameters

assembly
The assembly containing the embedded resources.
prefix
The prefix to search for.
directory
The directory to write the resources to.

See Also

EmbeddedResources Class | NDoc.Core Namespace


HtmlHelp Class

HTML Help file utilities.

For a list of all members of this type, see HtmlHelp Members.

System.Object
HtmlHelp

public class HtmlHelp

Remarks

This class is used by the MsdnHelp documenter to create the files needed by the HTML Help compiler.

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

HtmlHelp Members | NDoc.Core Namespace


HtmlHelp Members

HtmlHelp overview

Public Instance Constructors

HtmlHelp Constructor Initializes a new instance of the HtmlHelp class.

Public Instance Properties

DefaultTopic | Gets or sets the DefaultTopic property.
DirectoryName | Gets the directory name containing the HTML Help files.
HtmlHelpCompiler | Gets or sets the path to the HTML Help Compiler.
IncludeFavorites | Gets or sets the IncludeFavorites property.
ProjectName | Gets the HTML Help project name.

Public Instance Methods

AddFileToContents | Adds a file to the contents file.
AddFileToProject | Adds a file to the HTML Help project file.
CloseBookInContents | Closes the last opened "book" in the contents file.
CloseContentsFile | Closes the contents file.
CloseProjectFile | Closes the HTML Help project file.
CompileProject | Compiles the HTML Help project.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetPathToCompiledHtmlFile | Gets the path the the CHM file.
GetPathToContentsFile | Gets the path the the HHC file.
GetPathToIndexFile | Gets the path the the HHK file.
GetPathToLogFile | Gets the path the the LOG file.
GetPathToProjectFile | Gets the path the the HHP file.
GetType (inherited from Object) | Gets the Type of the current instance.
OpenBookInContents | Creates a new "book" in the HTML Help contents file.
OpenContentsFile | Opens a HTML Help contents file for writing.
OpenProjectFile | Opens an HTML Help project file for writing.
ToString (inherited from Object) | Returns a String that represents the current Object.
WriteEmptyIndexFile | Writes an empty index file.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp Constructor

Initializes a new instance of the HtmlHelp class.

public HtmlHelp(
string directoryName,
string projectName,
string defaultTopic,
string htmlHelpCompiler,
bool generateTocOnly
);

Parameters

directoryName
The directory to write the HTML Help files to.
projectName
The name of the HTML Help project.
defaultTopic
The default topic for the compiled HTML Help file.
htmlHelpCompiler
The path to the HTML Help compiler.
generateTocOnly
When true, HtmlHelp only outputs the HHC file and does not compile the CHM.

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp Properties

The properties of the HtmlHelp class are listed below. For a complete list of HtmlHelp class members, see the HtmlHelp Members topic.

Public Instance Properties

DefaultTopic | Gets or sets the DefaultTopic property.
DirectoryName | Gets the directory name containing the HTML Help files.
HtmlHelpCompiler | Gets or sets the path to the HTML Help Compiler.
IncludeFavorites | Gets or sets the IncludeFavorites property.
ProjectName | Gets the HTML Help project name.

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.DefaultTopic Property

Gets or sets the DefaultTopic property.

public string DefaultTopic {get; set;}

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.DirectoryName Property

Gets the directory name containing the HTML Help files.

public string DirectoryName {get;}

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.HtmlHelpCompiler Property

Gets or sets the path to the HTML Help Compiler.

public string HtmlHelpCompiler {get; set;}

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.IncludeFavorites Property

Gets or sets the IncludeFavorites property.

public bool IncludeFavorites {get; set;}

Remarks

Setting this to true will include the "favorites" tab in the compiled HTML Help file.

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.ProjectName Property

Gets the HTML Help project name.

public string ProjectName {get;}

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp Methods

The methods of the HtmlHelp class are listed below. For a complete list of HtmlHelp class members, see the HtmlHelp Members topic.

Public Instance Methods

AddFileToContents | Adds a file to the contents file.
AddFileToProject | Adds a file to the HTML Help project file.
CloseBookInContents | Closes the last opened "book" in the contents file.
CloseContentsFile | Closes the contents file.
CloseProjectFile | Closes the HTML Help project file.
CompileProject | Compiles the HTML Help project.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetPathToCompiledHtmlFile | Gets the path the the CHM file.
GetPathToContentsFile | Gets the path the the HHC file.
GetPathToIndexFile | Gets the path the the HHK file.
GetPathToLogFile | Gets the path the the LOG file.
GetPathToProjectFile | Gets the path the the HHP file.
GetType (inherited from Object) | Gets the Type of the current instance.
OpenBookInContents | Creates a new "book" in the HTML Help contents file.
OpenContentsFile | Opens a HTML Help contents file for writing.
OpenProjectFile | Opens an HTML Help project file for writing.
ToString (inherited from Object) | Returns a String that represents the current Object.
WriteEmptyIndexFile | Writes an empty index file.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.AddFileToContents Method

Adds a file to the contents file.

public void AddFileToContents(
string headingName,
string htmlFilename
);

Parameters

headingName
The name as it should appear in the contents.
htmlFilename
The filename for this entry.

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.AddFileToProject Method

Adds a file to the HTML Help project file.

public void AddFileToProject(
string filename
);

Parameters

filename
The filename to add.

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.CloseBookInContents Method

Closes the last opened "book" in the contents file.

public void CloseBookInContents();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.CloseContentsFile Method

Closes the contents file.

public void CloseContentsFile();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.CloseProjectFile Method

Closes the HTML Help project file.

public void CloseProjectFile();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.CompileProject Method

Compiles the HTML Help project.

public void CompileProject();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.GetPathToCompiledHtmlFile Method

Gets the path the the CHM file.

public string GetPathToCompiledHtmlFile();

Return Value

The path to the CHM file.

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.GetPathToContentsFile Method

Gets the path the the HHC file.

public string GetPathToContentsFile();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.GetPathToIndexFile Method

Gets the path the the HHK file.

public string GetPathToIndexFile();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.GetPathToLogFile Method

Gets the path the the LOG file.

public string GetPathToLogFile();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.GetPathToProjectFile Method

Gets the path the the HHP file.

public string GetPathToProjectFile();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.OpenBookInContents Method

Creates a new "book" in the HTML Help contents file.

public void OpenBookInContents();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.OpenContentsFile Method

Opens a HTML Help contents file for writing.

public void OpenContentsFile(
string tocName,
bool isDefault
);

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.OpenProjectFile Method

Opens an HTML Help project file for writing.

public void OpenProjectFile();

See Also

HtmlHelp Class | NDoc.Core Namespace


HtmlHelp.WriteEmptyIndexFile Method

Writes an empty index file.

public void WriteEmptyIndexFile();

Remarks

The HTML Help Compiler will complain if this file doesn't exist.

See Also

HtmlHelp Class | NDoc.Core Namespace


IDocumenter Interface

Represents a class capable of generating documentation from a given assembly and /doc file.

For a list of all members of this type, see IDocumenter Members.

public interface IDocumenter

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

IDocumenter Members | NDoc.Core Namespace


IDocumenter Members

IDocumenter overview

Public Instance Properties

Config | Gets or sets the documenter's config object.
DevelopmentStatus | The development status (alpha, beta, stable) of this documenter.
MainOutputFile | Returns the documenter's main output file path.
Name | Gets the display name for the documenter.

Public Instance Methods

Build | Builds the documentation.
CanBuild | Overloaded. Checks if the documentation output file(s) exist.
Clear | Resets the documenter to a clean state.
View | Spawns a new process to view the generated documentation.

Public Instance Events

DocBuildingProgress | Raised to update the current step's percent complete value.
DocBuildingStep | Raised to update the overall percent complete value and the current step name.

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter Properties

The properties of the IDocumenter interface are listed below. For a complete list of IDocumenter interface members, see the IDocumenter Members topic.

Public Instance Properties

Config | Gets or sets the documenter's config object.
DevelopmentStatus | The development status (alpha, beta, stable) of this documenter.
MainOutputFile | Returns the documenter's main output file path.
Name | Gets the display name for the documenter.

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter.Config Property

Gets or sets the documenter's config object.

IDocumenterConfig Config {get; set;}

Remarks

This can be put inside a PropertyGrid for editing by the user.

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter.DevelopmentStatus Property

The development status (alpha, beta, stable) of this documenter.

DocumenterDevelopmentStatus DevelopmentStatus {get;}

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter.MainOutputFile Property

Returns the documenter's main output file path.

string MainOutputFile {get;}

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter.Name Property

Gets the display name for the documenter.

string Name {get;}

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter Methods

The methods of the IDocumenter interface are listed below. For a complete list of IDocumenter interface members, see the IDocumenter Members topic.

Public Instance Methods

Build | Builds the documentation.
CanBuild | Overloaded. Checks if the documentation output file(s) exist.
Clear | Resets the documenter to a clean state.
View | Spawns a new process to view the generated documentation.

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter.Build Method

Builds the documentation.

void Build(
Project project
);

Remarks

The compiler does not currently allow namespaces to documented.

See Also

IDocumenter Interface | NDoc.Core Namespace


CanBuild Method

NDoc Documentation

IDocumenter.CanBuild Method

Checks if the documentation output file(s) exist.

Overload List

Checks if the documentation output file(s) exist.

string CanBuild(Project);

Checks to make sure the documenter can perform a build.

string CanBuild(Project,bool);

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter.CanBuild Method (Project)

Checks if the documentation output file(s) exist.

string CanBuild(
Project project
);

Parameters

project
The project that generated the documentation.

Return Value

True if the documentation can be viewed.

See Also

IDocumenter Interface | NDoc.Core Namespace | IDocumenter.CanBuild Overload List


IDocumenter.CanBuild Method (Project, Boolean)

Checks to make sure the documenter can perform a build.

string CanBuild(
Project project,
bool checkInputOnly
);

Parameters

project
The project that would be built.
checkInputOnly
When true, don't check for output file locking.

Return Value

null if the documenter can build; otherwise a message describing why it can't build

Remarks

This is for people who like to leave their CHMs open.

See Also

IDocumenter Interface | NDoc.Core Namespace | IDocumenter.CanBuild Overload List


IDocumenter.Clear Method

Resets the documenter to a clean state.

void Clear();

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter.View Method

Spawns a new process to view the generated documentation.

void View();

Exceptions

Exception Type | Condition
FileNotFoundException | Thrown if the main output file does not exist.

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter Events

The events of the IDocumenter interface are listed below. For a complete list of IDocumenter interface members, see the IDocumenter Members topic.

Public Instance Events

DocBuildingProgress | Raised to update the current step's percent complete value.
DocBuildingStep | Raised to update the overall percent complete value and the current step name.

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter.DocBuildingProgress Event

Raised to update the current step's percent complete value.

event DocBuildingEventHandler DocBuildingProgress;

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenter.DocBuildingStep Event

Raised to update the overall percent complete value and the current step name.

event DocBuildingEventHandler DocBuildingStep;

See Also

IDocumenter Interface | NDoc.Core Namespace


IDocumenterConfig Interface

Specifies the methods that are common to all documenter configs.

For a list of all members of this type, see IDocumenterConfig Members.

public interface IDocumenterConfig

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

IDocumenterConfig Members | NDoc.Core Namespace


IDocumenterConfig Members

IDocumenterConfig overview

Public Instance Methods

GetProperties | Gets a list of property names.
Read | Reads the previously serialized state of the documenter into memory.
SetProject | Associates the config with a project.
SetValue | Sets the value of a property.
Write | Writes the current state of the documenter to the specified XmlWrtier.

See Also

IDocumenterConfig Interface | NDoc.Core Namespace


IDocumenterConfig Methods

The methods of the IDocumenterConfig interface are listed below. For a complete list of IDocumenterConfig interface members, see the IDocumenterConfig Members topic.

Public Instance Methods

GetProperties | Gets a list of property names.
Read | Reads the previously serialized state of the documenter into memory.
SetProject | Associates the config with a project.
SetValue | Sets the value of a property.
Write | Writes the current state of the documenter to the specified XmlWrtier.

See Also

IDocumenterConfig Interface | NDoc.Core Namespace


IDocumenterConfig.GetProperties Method

Gets a list of property names.

IEnumerable GetProperties();

Return Value

An enumerable list of property names.

See Also

IDocumenterConfig Interface | NDoc.Core Namespace


IDocumenterConfig.Read Method

Reads the previously serialized state of the documenter into memory.

void Read(
XmlReader reader
);

Parameters

reader
An XmlReader positioned on a documenter element.

Remarks

This method uses reflection to set all of the public properties in the documenter.

See Also

IDocumenterConfig Interface | NDoc.Core Namespace


IDocumenterConfig.SetProject Method

Associates the config with a project.

void SetProject(
Project project
);

Remarks

Changes to the config will notify the project so that it can be marked as modified and saved.

See Also

IDocumenterConfig Interface | NDoc.Core Namespace


IDocumenterConfig.SetValue Method

Sets the value of a property.

void SetValue(
string name,
string value
);

Parameters

name
The name of the property.
value
The value of the property.

See Also

IDocumenterConfig Interface | NDoc.Core Namespace


IDocumenterConfig.Write Method

Writes the current state of the documenter to the specified XmlWrtier.

void Write(
XmlWriter writer
);

Parameters

writer
An XmlWriter.

Remarks

This method uses reflection to serialize all of the public properties in the documenter.

See Also

IDocumenterConfig Interface | NDoc.Core Namespace


ProgressArgs Class

Custom event arguments' class used by DocBuildingEventHandler.

For a list of all members of this type, see ProgressArgs Members.

System.Object
EventArgs
ProgressArgs

public class ProgressArgs : EventArgs

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

ProgressArgs Members | NDoc.Core Namespace


ProgressArgs Members

ProgressArgs overview

Public Instance Constructors

ProgressArgs Constructor ProgressArgs default constructor.

Public Instance Properties

Progress | Gets the percentage value.
Status | Gets the current work label.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

ProgressArgs Class | NDoc.Core Namespace


ProgressArgs Constructor

ProgressArgs default constructor.

public ProgressArgs(
int progress,
string status
);

Parameters

progress
Percentage value for a progress bar.
status
The label describing the current work beeing done.

See Also

ProgressArgs Class | NDoc.Core Namespace


ProgressArgs Properties

The properties of the ProgressArgs class are listed below. For a complete list of ProgressArgs class members, see the ProgressArgs Members topic.

Public Instance Properties

Progress | Gets the percentage value.
Status | Gets the current work label.

See Also

ProgressArgs Class | NDoc.Core Namespace


ProgressArgs.Progress Property

Gets the percentage value.

public int Progress {get;}

Property Value

A number between 0 and 100 corresponding to the percentage of work completed.

See Also

ProgressArgs Class | NDoc.Core Namespace


ProgressArgs.Status Property

Gets the current work label.

public string Status {get;}

Property Value

A short description of the current work beeing done.

See Also

ProgressArgs Class | NDoc.Core Namespace


Project Class

Represents an NDoc project.

For a list of all members of this type, see Project Members.

System.Object
Project

public class Project

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

Project Members | NDoc.Core Namespace


Project Members

Project overview

Public Static Methods

FindDocumenters Searches the module directory for assemblies containing classes the implement IDocumenter.

Public Instance Constructors

Project Constructor Initializes a new instance of the Project class.

Public Instance Properties

AssemblySlashDocCount | Gets the number of assembly/doc pairs in the project.
Documenters | Gets or sets the Documenters property.
IsDirty | Gets the IsDirty property.
NamespaceCount | The number of namespaces in the project.

Public Instance Methods

AddAssemblySlashDoc | Adds an assembly/doc pair to the project.
Clear | Clears the project.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
FindAssemblySlashDocByName | Returns the index of the assembly/doc based on an assembly name.
GetAssemblySlashDoc | Gets an assembly/doc pair.
GetAssemblySlashDocs | Gets an enumerable list of assembly/doc pairs.
GetDocumenter | Retrieves a documenter by name.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetNamespaces | Gets an enumerable list of namespace names.
GetNamespaceSummary | Gets the summary for a namespace.
GetType (inherited from Object) | Gets the Type of the current instance.
Read | Reads an NDoc project file.
ReadNamespaceSummaries | Loads namespace summaries from an XML document.
RemoveAssemblySlashDoc | Removes an assembly/doc pair from the project.
SetNamespaceSummary | Sets a namespace summary.
ToString (inherited from Object) | Returns a String that represents the current Object.
Write | Writes an NDoc project file.

Public Instance Events

Modified Raised by projects when they're dirty state changes from false to true.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

Project Class | NDoc.Core Namespace


Project Constructor

Initializes a new instance of the Project class.

public Project();

See Also

Project Class | NDoc.Core Namespace


Project Properties

The properties of the Project class are listed below. For a complete list of Project class members, see the Project Members topic.

Public Instance Properties

AssemblySlashDocCount | Gets the number of assembly/doc pairs in the project.
Documenters | Gets or sets the Documenters property.
IsDirty | Gets the IsDirty property.
NamespaceCount | The number of namespaces in the project.

See Also

Project Class | NDoc.Core Namespace


Project.AssemblySlashDocCount Property

Gets the number of assembly/doc pairs in the project.

public int AssemblySlashDocCount {get;}

See Also

Project Class | NDoc.Core Namespace


Project.Documenters Property

Gets or sets the Documenters property.

public System.Collections.ArrayList Documenters {get;}

See Also

Project Class | NDoc.Core Namespace


Project.IsDirty Property

Gets the IsDirty property.

public bool IsDirty {get; set;}

See Also

Project Class | NDoc.Core Namespace


Project.NamespaceCount Property

The number of namespaces in the project.

public int NamespaceCount {get;}

See Also

Project Class | NDoc.Core Namespace


Project Methods

The methods of the Project class are listed below. For a complete list of Project class members, see the Project Members topic.

Public Static Methods

FindDocumenters Searches the module directory for assemblies containing classes the implement IDocumenter.

Public Instance Methods

AddAssemblySlashDoc | Adds an assembly/doc pair to the project.
Clear | Clears the project.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
FindAssemblySlashDocByName | Returns the index of the assembly/doc based on an assembly name.
GetAssemblySlashDoc | Gets an assembly/doc pair.
GetAssemblySlashDocs | Gets an enumerable list of assembly/doc pairs.
GetDocumenter | Retrieves a documenter by name.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetNamespaces | Gets an enumerable list of namespace names.
GetNamespaceSummary | Gets the summary for a namespace.
GetType (inherited from Object) | Gets the Type of the current instance.
Read | Reads an NDoc project file.
ReadNamespaceSummaries | Loads namespace summaries from an XML document.
RemoveAssemblySlashDoc | Removes an assembly/doc pair from the project.
SetNamespaceSummary | Sets a namespace summary.
ToString (inherited from Object) | Returns a String that represents the current Object.
Write | Writes an NDoc project file.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

Project Class | NDoc.Core Namespace


Project.AddAssemblySlashDoc Method

Adds an assembly/doc pair to the project.

public bool AddAssemblySlashDoc(
AssemblySlashDoc assemblySlashDoc
);

Return Value

bool - true for doc added, false or exception otherwise

See Also

Project Class | NDoc.Core Namespace


Project.Clear Method

Clears the project.

public void Clear();

See Also

Project Class | NDoc.Core Namespace


Project.FindAssemblySlashDocByName Method

Returns the index of the assembly/doc based on an assembly name.

public int FindAssemblySlashDocByName(
string assemblyName
);

Parameters

assemblyName
The assembly to search for.

Return Value

See Also

Project Class | NDoc.Core Namespace


Project.FindDocumenters Method

Searches the module directory for assemblies containing classes the implement IDocumenter.

public static ArrayList FindDocumenters();

Return Value

An ArrayList containing new instances of all the found documenters.

See Also

Project Class | NDoc.Core Namespace


Project.GetAssemblySlashDoc Method

Gets an assembly/doc pair.

public AssemblySlashDoc GetAssemblySlashDoc(
int index
);

See Also

Project Class | NDoc.Core Namespace


Project.GetAssemblySlashDocs Method

Gets an enumerable list of assembly/doc pairs.

public IEnumerable GetAssemblySlashDocs();

See Also

Project Class | NDoc.Core Namespace


Project.GetDocumenter Method

Retrieves a documenter by name.

public IDocumenter GetDocumenter(
string name
);

See Also

Project Class | NDoc.Core Namespace


Project.GetNamespaces Method

Gets an enumerable list of namespace names.

public IEnumerable GetNamespaces();

See Also

Project Class | NDoc.Core Namespace


Project.GetNamespaceSummary Method

Gets the summary for a namespace.

public string GetNamespaceSummary(
string namespaceName
);

See Also

Project Class | NDoc.Core Namespace


Project.Read Method

Reads an NDoc project file.

public void Read(
string filename
);

See Also

Project Class | NDoc.Core Namespace


Project.ReadNamespaceSummaries Method

Loads namespace summaries from an XML document.

public void ReadNamespaceSummaries(
XmlReader reader
);

Parameters

reader
An open XmlReader positioned before the namespace elements.

See Also

Project Class | NDoc.Core Namespace


Project.RemoveAssemblySlashDoc Method

Removes an assembly/doc pair from the project.

public void RemoveAssemblySlashDoc(
int index
);

See Also

Project Class | NDoc.Core Namespace


Project.SetNamespaceSummary Method

Sets a namespace summary.

public void SetNamespaceSummary(
string namespaceName,
string summary
);

See Also

Project Class | NDoc.Core Namespace


Project.Write Method

Writes an NDoc project file.

public void Write(
string filename
);

See Also

Project Class | NDoc.Core Namespace


Project Events

The events of the Project class are listed below. For a complete list of Project class members, see the Project Members topic.

Public Instance Events

Modified Raised by projects when they're dirty state changes from false to true.

See Also

Project Class | NDoc.Core Namespace


Project.Modified Event

Raised by projects when they're dirty state changes from false to true.

public event ProjectModifiedEventHandler Modified;

See Also

Project Class | NDoc.Core Namespace


Project.AssemblyAlreadyExistsException Class

A custom exception to detect if a duplicate assembly is beeing added.

For a list of all members of this type, see Project.AssemblyAlreadyExistsException Members.

System.Object
Exception
ApplicationException
Project.AssemblyAlreadyExistsException

public class Project.AssemblyAlreadyExistsException : ApplicationException

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

Project.AssemblyAlreadyExistsException Members | NDoc.Core Namespace


Project.AssemblyAlreadyExistsException Members

Project.AssemblyAlreadyExistsException overview

Public Instance Constructors

Project.AssemblyAlreadyExistsException Constructor Initializes a new instance of the AssemblyAlreadyExistsException class with a specified error message.

Public Instance Properties

HelpLink (inherited from Exception) | Gets or sets a link to the help file associated with this exception.
InnerException (inherited from Exception) | Gets the Exception instance that caused the current exception.
Message (inherited from Exception) | Gets a message that describes the current exception.
Source (inherited from Exception) | Gets or sets the name of the application or the object that causes the error.
StackTrace (inherited from Exception) | Gets a string representation of the frames on the call stack at the time the current exception was thrown.
TargetSite (inherited from Exception) | Gets the method that throws the current exception.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetBaseException (inherited from Exception) | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetObjectData (inherited from Exception) | When overridden in a derived class, sets the SerializationInfo with information about the exception.
GetType (inherited from Object) | Gets the Type of the current instance.
ToString (inherited from Exception) | Creates and returns a string representation of the current exception.

Protected Instance Properties

HResult (inherited from Exception) Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

Project.AssemblyAlreadyExistsException Class | NDoc.Core Namespace


Project.AssemblyAlreadyExistsException Constructor

Initializes a new instance of the AssemblyAlreadyExistsException class with a specified error message.

public Project.AssemblyAlreadyExistsException(
string message
);

See Also

Project.AssemblyAlreadyExistsException Class | NDoc.Core Namespace


ProjectModifiedEventHandler Delegate

Handles ProjectModified events.

public delegate void ProjectModifiedEventHandler(
object sender,
EventArgs e
);

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

NDoc.Core Namespace


SimpleEdit Class

This is a dialog box to prompt for a name.

For a list of all members of this type, see SimpleEdit Members.

System.Object
MarshalByRefObject
Component
Control
ScrollableControl
ContainerControl
Form
SimpleEdit

public class SimpleEdit : Form

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

SimpleEdit Members | NDoc.Core Namespace


SimpleEdit Members

SimpleEdit overview

Public Instance Constructors

SimpleEdit Constructor Creates a SimpleEdit form.

Public Instance Fields

Value Contains the value of the text box.

Public Instance Properties

AcceptButton (inherited from Form) | Gets or sets the button on the form that is clicked when the user presses the ENTER key.
AccessibilityObject (inherited from Control) | Gets the AccessibleObject assigned to the control.
AccessibleDefaultActionDescription (inherited from Control) | Gets or sets the default action description of the control for use by accessibility client applications.
AccessibleDescription (inherited from Control) | Gets or sets the description of the control used by accessibility client applications.
AccessibleName (inherited from Control) | Gets or sets the name of the control used by accessibility client applications.
AccessibleRole (inherited from Control) | Gets or sets the accessible role of the control
ActiveControl (inherited from ContainerControl) | Gets or sets the active control on the container control.
ActiveMdiChild (inherited from Form) | Gets the currently active multiple document interface (MDI) child window.
AllowDrop (inherited from Control) | Gets or sets a value indicating whether the control can accept data that the user drags onto it.
AllowTransparency (inherited from Form) |
Anchor (inherited from Control) | Gets or sets which edges of the control are anchored to the edges of its container.
AutoScale (inherited from Form) | Gets or sets a value indicating whether the form adjusts its size to fit the height of the font used on the form and scales its controls.
AutoScaleBaseSize (inherited from Form) | Gets or sets the base size used for autoscaling of the form.
AutoScroll (inherited from Form) | Gets or sets a value indicating whether the form enables autoscrolling.
AutoScrollMargin (inherited from ScrollableControl) | Gets or sets the size of the auto-scroll margin.
AutoScrollMinSize (inherited from ScrollableControl) | Gets or sets the minimum size of the auto-scroll.
AutoScrollPosition (inherited from ScrollableControl) | Gets or sets the location of the auto-scroll position.
BackColor (inherited from Form) |
BackgroundImage (inherited from Control) | Gets or sets the background image displayed in the control.
BindingContext (inherited from ContainerControl) |
Bottom (inherited from Control) | Gets the distance between the bottom edge of the control and the top edge of its container's client area.
Bounds (inherited from Control) | Gets or sets the size and location of the control including its nonclient elements.
CancelButton (inherited from Form) | Gets or sets the button control that is clicked when the user presses the ESC key.
CanFocus (inherited from Control) | Gets a value indicating whether the control can receive focus.
CanSelect (inherited from Control) | Gets a value indicating whether the control can be selected.
Capture (inherited from Control) | Gets or sets a value indicating whether the control has captured the mouse.
CausesValidation (inherited from Control) | Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
ClientRectangle (inherited from Control) | Gets the rectangle that represents the client area of the control.
ClientSize (inherited from Form) | Gets or sets the size of the client area of the form.
CompanyName (inherited from Control) | Gets the name of the company or creator of the application containing the control.
Container (inherited from Component) | Gets the IContainer that contains the Component.
ContainsFocus (inherited from Control) | Gets a value indicating whether the control, or one of its child controls, currently has the input focus.
ContextMenu (inherited from Control) | Gets or sets the shortcut menu associated with the control.
ControlBox (inherited from Form) | Gets or sets a value indicating whether a control box is displayed in the caption bar of the form.
Controls (inherited from Control) | Gets the collection of controls contained within the control.
Created (inherited from Control) | Gets a value indicating whether the control has been created.
Cursor (inherited from Control) | Gets or sets the cursor that is displayed when the mouse pointer is over the control.
DataBindings (inherited from Control) | Gets the data bindings for the control.
DesktopBounds (inherited from Form) | Gets or sets the size and location of the form on the Windows desktop.
DesktopLocation (inherited from Form) | Gets or sets the location of the form on the Windows desktop.
DialogResult (inherited from Form) | Gets or sets the dialog result for the form.
DisplayRectangle (inherited from ScrollableControl) |
Disposing (inherited from Control) | Gets a value indicating whether the control is in the process of being disposed of.
Dock (inherited from Control) | Gets or sets which edge of the parent container a control is docked to.
DockPadding (inherited from ScrollableControl) | Gets the dock padding settings for all edges of the control.
Enabled (inherited from Control) | Gets or sets a value indicating whether the control can respond to user interaction.
Focused (inherited from Control) | Gets a value indicating whether the control has input focus.
Font (inherited from Control) | Gets or sets the font of the text displayed by the control.
ForeColor (inherited from Control) | Gets or sets the foreground color of the control.
FormBorderStyle (inherited from Form) | Gets or sets the border style of the form.
Handle (inherited from Control) | Gets the window handle that the control is bound to.
HasChildren (inherited from Control) | Gets a value indicating whether the control contains one or more child controls.
Height (inherited from Control) | Gets or sets the height of the control.
HelpButton (inherited from Form) | Gets or sets a value indicating whether a Help button should be displayed in the caption box of the form.
Icon (inherited from Form) | Gets or sets the icon for the form.
ImeMode (inherited from Control) | Gets or sets the Input Method Editor (IME) mode of the control.
InvokeRequired (inherited from Control) | Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on.
IsAccessible (inherited from Control) | Gets or sets a value indicating whether the control is visible to accessibility applications.
IsDisposed (inherited from Control) | Gets a value indicating whether the control has been disposed of.
IsHandleCreated (inherited from Control) | Gets a value indicating whether the control has a handle associated with it.
IsMdiChild (inherited from Form) | Gets a value indicating whether the form is a multiple document interface (MDI) child form.
IsMdiContainer (inherited from Form) | Gets or sets a value indicating whether the form is a container for multiple document interface (MDI) child forms.
IsRestrictedWindow (inherited from Form) |
KeyPreview (inherited from Form) | Gets or sets a value indicating whether the form will receive key events before the event is passed to the control that has focus.
Left (inherited from Control) | Gets or sets the x-coordinate of a control's left edge in pixels.
Location (inherited from Control) | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
MaximizeBox (inherited from Form) | Gets or sets a value indicating whether the maximize button is displayed in the caption bar of the form.
MaximumSize (inherited from Form) | Gets the maximum size the form can be resized to.
MdiChildren (inherited from Form) | Gets an array of forms that represent the multiple document interface (MDI) child forms that are parented to this form.
MdiParent (inherited from Form) | Gets or sets the current multiple document interface (MDI) parent form of this form.
Menu (inherited from Form) | Gets or sets the MainMenu that is displayed in the form.
MergedMenu (inherited from Form) | Gets the merged menu for the form.
MinimizeBox (inherited from Form) | Gets or sets a value indicating whether the minimize button is displayed in the caption bar of the form.
MinimumSize (inherited from Form) | Gets or sets the minimum size the form can be resized to.
Modal (inherited from Form) | Gets a value indicating whether this form is displayed modally.
Name (inherited from Control) | Gets or sets the name of the control.
Opacity (inherited from Form) | Gets or sets the opacity level of the form.
OwnedForms (inherited from Form) | Gets an array of Form objects that represent all forms that are owned by this form.
Owner (inherited from Form) | Gets or sets the form that owns this form.
Parent (inherited from Control) | Gets or sets the parent container of the control.
ParentForm (inherited from ContainerControl) | Gets the form that the container control is assigned to.
ProductName (inherited from Control) | Gets the product name of the assembly containing the control.
ProductVersion (inherited from Control) | Gets the version of the assembly containing the control.
RecreatingHandle (inherited from Control) | Gets a value indicating whether the control is currently re-creating its handle.
Region (inherited from Control) | Gets or sets the window region associated with the control.
Right (inherited from Control) | Gets the distance between the right edge of the control and the left edge of its container.
RightToLeft (inherited from Control) | Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
ShowInTaskbar (inherited from Form) | Gets or sets a value indicating whether the form is displayed in the Windows taskbar.
Site (inherited from Control) | Gets or sets the site of the control.
Size (inherited from Form) | Gets or sets the size of the form.
SizeGripStyle (inherited from Form) | Gets or sets the style of the size grip to display in the lower-right corner of the form.
StartPosition (inherited from Form) | Gets or sets the starting position of the form at run time.
TabIndex (inherited from Form) |
TabStop (inherited from Control) | Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
Tag (inherited from Control) | Gets or sets the object that contains data about the control.
Text (inherited from Control) | Gets or sets the text associated with this control.
Top (inherited from Control) | Gets or sets the y-coordinate of the control's top edge in pixels.
TopLevel (inherited from Form) | Gets or sets a value indicating whether to display the form as a top-level window.
TopLevelControl (inherited from Control) | Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
TopMost (inherited from Form) | Gets or sets a value indicating whether the form should be displayed as the top-most form of your application.
TransparencyKey (inherited from Form) | Gets or sets the color that will represent transparent areas of the form.
Visible (inherited from Control) | Gets or sets a value indicating whether the control is displayed.
Width (inherited from Control) | Gets or sets the width of the control.
WindowState (inherited from Form) | Gets or sets the form's window state.
WindowTarget (inherited from Control) |

Public Instance Methods

Activate (inherited from Form) | Activates the form and gives it focus.
AddOwnedForm (inherited from Form) | Adds an owned form to this form.
BeginInvoke (inherited from Control) | Overloaded. Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
BringToFront (inherited from Control) | Brings the control to the front of the z-order.
Close (inherited from Form) | Closes the form.
Contains (inherited from Control) | Retrieves a value indicating whether the specified control is a child of the control.
CreateControl (inherited from Control) | Forces the creation of the control, including the creation of the handle and any child controls.
CreateGraphics (inherited from Control) | Creates the Graphics object for the control.
CreateObjRef (inherited from MarshalByRefObject) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose (inherited from Component) | Overloaded. Releases all resources used by the Component.
DoDragDrop (inherited from Control) | Begins a drag-and-drop operation.
EndInvoke (inherited from Control) | Retrieves the return value of the asynchronous operation represented by the IAsyncResult object passed.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
FindForm (inherited from Control) | Retrieves the form that the control is on.
Focus (inherited from Control) | Sets input focus to the control.
GetChildAtPoint (inherited from Control) | Retrieves the child control that is located at the specified coordinates.
GetContainerControl (inherited from Control) | Returns the next ContainerControl up the control's chain of parent controls.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) | Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetNextControl (inherited from Control) | Retrieves the next control forward or back in the tab order of child controls.
GetType (inherited from Object) | Gets the Type of the current instance.
Hide (inherited from Control) | Conceals the control from the user.
InitializeLifetimeService (inherited from MarshalByRefObject) | Obtains a lifetime service object to control the lifetime policy for this instance.
Invalidate (inherited from Control) | Overloaded. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
Invoke (inherited from Control) | Overloaded. Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
LayoutMdi (inherited from Form) | Arranges the multiple document interface (MDI) child forms within the MDI parent form.
PerformLayout (inherited from Control) | Overloaded. Forces the control to apply layout logic to all its child controls.
PointToClient (inherited from Control) | Computes the location of the specified screen point into client coordinates.
PointToScreen (inherited from Control) | Computes the location of the specified client point into screen coordinates.
PreProcessMessage (inherited from Control) | Preprocesses input messages within the message loop before they are dispatched.
RectangleToClient (inherited from Control) | Computes the size and location of the specified screen rectangle in client coordinates.
RectangleToScreen (inherited from Control) | Computes the size and location of the specified client rectangle in screen coordinates.
Refresh (inherited from Control) | Forces the control to invalidate its client area and immediately redraw itself and any child controls.
RemoveOwnedForm (inherited from Form) | Removes an owned form from this form.
ResetBackColor (inherited from Control) | Resets the BackColor property to its default value.
ResetBindings (inherited from Control) | Resets the DataBindings property to its default value.
ResetCursor (inherited from Control) | Resets the Cursor property to its default value.
ResetFont (inherited from Control) | Resets the Fontproperty to its default value.
ResetForeColor (inherited from Control) | Resets the ForeColor property to its default value.
ResetImeMode (inherited from Control) | Resets the ImeMode property to its default value.
ResetRightToLeft (inherited from Control) | Resets the RightToLeft property to its default value.
ResetText (inherited from Control) | Resets the Text property to its default value.
ResumeLayout (inherited from Control) | Overloaded. Resumes normal layout logic.
Scale (inherited from Control) | Overloaded. Scales the control and any child controls to the specified ratio.
ScrollControlIntoView (inherited from ScrollableControl) |
Select (inherited from Control) | Overloaded. Activates the control.
SelectNextControl (inherited from Control) | Activates the next control.
SendToBack (inherited from Control) | Sends the control to the back of the z-order.
SetAutoScrollMargin (inherited from ScrollableControl) | Sets the size of the auto-scroll margins.
SetBounds (inherited from Control) | Overloaded. Sets the bounds of the control to the specified location and size.
SetDesktopBounds (inherited from Form) | Sets the bounds of the form in desktop coordinates.
SetDesktopLocation (inherited from Form) | Sets the location of the form in desktop coordinates.
Show (inherited from Control) | Displays the control to the user.
ShowDialog (inherited from Form) | Overloaded. Shows the form as a modal dialog box with no owner window.
SuspendLayout (inherited from Control) | Temporarily suspends the layout logic for the control.
ToString (inherited from Form) |
Update (inherited from Control) | Causes the control to redraw the invalidated regions within its client area.
Validate (inherited from ContainerControl) | Validates the last invalidated control and its ancestors up through, but not including, the current control.

Public Instance Events

Activated (inherited from Form) | Occurs when the form is activated in code or by the user.
BackColorChanged (inherited from Control) | Occurs when the value of the BackColor property changes.
BackgroundImageChanged (inherited from Control) | Occurs when the value of the BackgroundImage property changes.
BindingContextChanged (inherited from Control) | Occurs when the value of the BindingContext property changes.
CausesValidationChanged (inherited from Control) | Occurs when the value of the CausesValidation property changes.
ChangeUICues (inherited from Control) | Occurs when the focus or keyboard user interface (UI) cues change.
Click (inherited from Control) | Occurs when the control is clicked.
Closed (inherited from Form) | Occurs when the form is closed.
Closing (inherited from Form) | Occurs when the form is closing.
ContextMenuChanged (inherited from Control) | Occurs when the value of the ContextMenu property changes.
ControlAdded (inherited from Control) | Occurs when a new control is added to the ControlCollection .
ControlRemoved (inherited from Control) | Occurs when a control is removed from the ControlCollection .
CursorChanged (inherited from Control) | Occurs when the value of the Cursor property changes.
Deactivate (inherited from Form) | Occurs when the form loses focus and is not the active form.
Disposed (inherited from Component) | Adds an event handler to listen to the Disposed event on the component.
DockChanged (inherited from Control) | Occurs when the value of the Dock property changes.
DoubleClick (inherited from Control) | Occurs when the control is double-clicked.
DragDrop (inherited from Control) | Occurs when a drag-and-drop operation is completed.
DragEnter (inherited from Control) | Occurs when an object is dragged into the control's bounds.
DragLeave (inherited from Control) | Occurs when an object is dragged out of the control's bounds.
DragOver (inherited from Control) | Occurs when an object is dragged over the control's bounds.
EnabledChanged (inherited from Control) | Occurs when the Enabled property value has changed.
Enter (inherited from Control) | Occurs when the control is entered.
FontChanged (inherited from Control) | Occurs when the Font property value changes.
ForeColorChanged (inherited from Control) | Occurs when the ForeColor property value changes.
GiveFeedback (inherited from Control) | Occurs during a drag operation.
GotFocus (inherited from Control) | Occurs when the control receives focus.
HandleCreated (inherited from Control) | Occurs when a handle is created for the control.
HandleDestroyed (inherited from Control) | Occurs when the control's handle is in the process of being destroyed.
HelpRequested (inherited from Control) | Occurs when the user requests help for a control.
ImeModeChanged (inherited from Control) | Occurs when the ImeMode property has changed.
InputLanguageChanged (inherited from Form) | Occurs after the input language of the form has changed.
InputLanguageChanging (inherited from Form) | Occurs when the user attempts to change the input language for the form.
Invalidated (inherited from Control) | Occurs when a control's display requires redrawing.
KeyDown (inherited from Control) | Occurs when a key is pressed while the control has focus.
KeyPress (inherited from Control) | Occurs when a key is pressed while the control has focus.
KeyUp (inherited from Control) | Occurs when a key is released while the control has focus.
Layout (inherited from Control) | Occurs when a control should reposition its child controls.
Leave (inherited from Control) | Occurs when the input focus leaves the control.
Load (inherited from Form) | Occurs before a form is displayed for the first time.
LocationChanged (inherited from Control) | Occurs when the Location property value has changed.
LostFocus (inherited from Control) | Occurs when the control loses focus.
MaximizedBoundsChanged (inherited from Form) | Occurs when the value of the MaximizedBounds property has changed.
MaximumSizeChanged (inherited from Form) | Occurs when the value of the MaximumSize property has changed.
MdiChildActivate (inherited from Form) | Occurs when a multiple document interface (MDI) child form is activated or closed within an MDI application.
MenuComplete (inherited from Form) | Occurs when the menu of a form loses focus.
MenuStart (inherited from Form) | Occurs when the menu of a form receives focus.
MinimumSizeChanged (inherited from Form) | Occurs when the value of the MinimumSize property has changed.
MouseDown (inherited from Control) | Occurs when the mouse pointer is over the control and a mouse button is pressed.
MouseEnter (inherited from Control) | Occurs when the mouse pointer enters the control.
MouseHover (inherited from Control) | Occurs when the mouse pointer hovers over the control.
MouseLeave (inherited from Control) | Occurs when the mouse pointer leaves the control.
MouseMove (inherited from Control) | Occurs when the mouse pointer is moved over the control.
MouseUp (inherited from Control) | Occurs when the mouse pointer is over the control and a mouse button is released.
MouseWheel (inherited from Control) | Occurs when the mouse wheel moves while the control has focus.
Move (inherited from Control) | Occurs when the control is moved.
Paint (inherited from Control) | Occurs when the control is redrawn.
ParentChanged (inherited from Control) | Occurs when the Parent property value changes.
QueryAccessibilityHelp (inherited from Control) | Occurs when AccessibleObject is providing help to accessibility applications.
QueryContinueDrag (inherited from Control) | Occurs during a drag-and-drop operation and allows the drag source to determine whether the drag-and-drop operation should be canceled.
Resize (inherited from Control) | Occurs when the control is resized.
RightToLeftChanged (inherited from Control) | Occurs when the RightToLeft property value changes.
SizeChanged (inherited from Control) | Occurs when the Size property value changes.
StyleChanged (inherited from Control) | Occurs when the control style changes.
SystemColorsChanged (inherited from Control) | Occurs when the system colors change.
TabIndexChanged (inherited from Form) |
TabStopChanged (inherited from Control) | Occurs when the TabStop property value changes.
TextChanged (inherited from Control) | Occurs when the Text property value changes.
Validated (inherited from Control) | Occurs when the control is finished validating.
Validating (inherited from Control) | Occurs when the control is validating.
VisibleChanged (inherited from Control) | Occurs when the Visible property value changes.

Protected Instance Properties

CreateParams (inherited from Form) |
DefaultImeMode (inherited from Form) | Gets the default Input Method Editor (IME) mode supported by the control.
DefaultSize (inherited from Form) |
DesignMode (inherited from Component) | Gets a value that indicates whether the Component is currently in design mode.
Events (inherited from Component) | Gets the list of event handlers that are attached to this Component.
FontHeight (inherited from Control) | Gets or sets the height of the font of the control.
HScroll (inherited from ScrollableControl) | Gets or sets a value indicating whether the horizontal scroll bar is visible.
MaximizedBounds (inherited from Form) | Gets and sets the size of the form when it is maximized.
RenderRightToLeft (inherited from Control) |
ResizeRedraw (inherited from Control) | Gets or sets a value indicating whether the control redraws itself when resized.
ShowFocusCues (inherited from Control) | Gets a value indicating whether the control should display focus rectangles.
ShowKeyboardCues (inherited from Control) | Gets a value indicating whether the control should display keyboard shortcuts.
VScroll (inherited from ScrollableControl) | Gets or sets a value indicating whether the vertical scroll bar is visible.

Protected Instance Methods

AccessibilityNotifyClients (inherited from Control) | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control.
ActivateMdiChild (inherited from Form) |
AdjustFormScrollbars (inherited from Form) |
ApplyAutoScaling (inherited from Form) |
CenterToParent (inherited from Form) |
CenterToScreen (inherited from Form) |
CreateAccessibilityInstance (inherited from Control) | Creates a new accessibility object for the control.
CreateControlsInstance (inherited from Form) |
CreateHandle (inherited from Form) |
DefWndProc (inherited from Form) |
DestroyHandle (inherited from Control) | Destroys the handle associated with the control.
Dispose | Overloaded. Clean up any resources being used.
Finalize (inherited from Component) | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
GetScrollState (inherited from ScrollableControl) |
GetService (inherited from Component) | Returns an object that represents a service provided by the Component or by its Container.
GetStyle (inherited from Control) | Retrieves the value of the specified control style bit for the control.
GetTopLevel (inherited from Control) | Determines if the control is a top-level control.
InitLayout (inherited from Control) | Called after the control has been added to another container.
InvokeGotFocus (inherited from Control) | Raises the GotFocus event for the specified control.
InvokeLostFocus (inherited from Control) | Raises the LostFocus event for the specified control.
InvokeOnClick (inherited from Control) | Raises the Click event for the specified control.
InvokePaint (inherited from Control) | Raises the Paint event for the specified control.
InvokePaintBackground (inherited from Control) | Raises the PaintBackground event for the specified control.
IsInputChar (inherited from Control) | Determines if a character is an input character that the control recognizes.
IsInputKey (inherited from Control) | Determines whether the specified key is a regular input key or a special key that requires preprocessing.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
NotifyInvalidate (inherited from Control) |
OnActivated (inherited from Form) | Raises the Activated event.
OnBackColorChanged (inherited from Control) | Raises the BackColorChanged event.
OnBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event.
OnBindingContextChanged (inherited from Control) | Raises the BindingContextChangedevent.
OnCausesValidationChanged (inherited from Control) | Raises the CausesValidationChangedevent.
OnChangeUICues (inherited from Control) | Raises the ChangeUICues event.
OnClick (inherited from Control) | Raises the Click event.
OnClosed (inherited from Form) | Raises the Closed event.
OnClosing (inherited from Form) | Raises the Closing event.
OnContextMenuChanged (inherited from Control) | Raises the ContextMenuChangedevent.
OnControlAdded (inherited from Control) | Raises the ControlAdded event.
OnControlRemoved (inherited from ContainerControl) |
OnCreateControl (inherited from Form) |
OnCursorChanged (inherited from Control) | Raises the CursorChangedevent.
OnDeactivate (inherited from Form) | Raises the Deactivate event.
OnDockChanged (inherited from Control) | Raises the DockChangedevent.
OnDoubleClick (inherited from Control) | Raises the DoubleClick event.
OnDragDrop (inherited from Control) | Raises the DragDrop event.
OnDragEnter (inherited from Control) | Raises the DragEnter event.
OnDragLeave (inherited from Control) | Raises the DragLeave event.
OnDragOver (inherited from Control) | Raises the DragOver event.
OnEnabledChanged (inherited from Control) | Raises the EnabledChanged event.
OnEnter (inherited from Control) | Raises the Enter event.
OnFontChanged (inherited from Form) |
OnForeColorChanged (inherited from Control) | Raises the ForeColorChangedevent.
OnGiveFeedback (inherited from Control) | Raises the GiveFeedback event.
OnGotFocus (inherited from Control) | Raises the GotFocus event.
OnHandleCreated (inherited from Form) |
OnHandleDestroyed (inherited from Form) |
OnHelpRequested (inherited from Control) | Raises the HelpRequested event.
OnImeModeChanged (inherited from Control) | Raises the ImeModeChanged event.
OnInputLanguageChanged (inherited from Form) | Raises the InputLanguageChanged event.
OnInputLanguageChanging (inherited from Form) | Raises the InputLanguageChanging event.
OnInvalidated (inherited from Control) | Raises the Invalidated event.
OnKeyDown (inherited from Control) | Raises the KeyDown event.
OnKeyPress (inherited from Control) | Raises the KeyPress event.
OnKeyUp (inherited from Control) | Raises the KeyUp event.
OnLayout (inherited from ScrollableControl) |
OnLeave (inherited from Control) | Raises the Leave event.
OnLoad (inherited from Form) | Raises the Load event.
OnLocationChanged (inherited from Control) | Raises the LocationChanged event.
OnLostFocus (inherited from Control) | Raises the LostFocus event.
OnMaximizedBoundsChanged (inherited from Form) | Raises the MaximizedBoundsChanged event.
OnMaximumSizeChanged (inherited from Form) | Raises the MaximumSizeChanged event.
OnMdiChildActivate (inherited from Form) | Raises the MdiChildActivate event.
OnMenuComplete (inherited from Form) | Raises the MenuComplete event.
OnMenuStart (inherited from Form) | Raises the MenuStart event.
OnMinimumSizeChanged (inherited from Form) | Raises the MinimumSizeChanged event.
OnMouseDown (inherited from Control) | Raises the MouseDown event.
OnMouseEnter (inherited from Control) | Raises the MouseEnter event.
OnMouseHover (inherited from Control) | Raises the MouseHover event.
OnMouseLeave (inherited from Control) | Raises the MouseLeave event.
OnMouseMove (inherited from Control) | Raises the MouseMove event.
OnMouseUp (inherited from Control) | Raises the MouseUp event.
OnMouseWheel (inherited from ScrollableControl) |
OnMove (inherited from Control) | Raises the Move event.
OnNotifyMessage (inherited from Control) | Notifies the control of Windows messages.
OnPaint (inherited from Form) |
OnPaintBackground (inherited from Control) | Paints the background of the control.
OnParentBackColorChanged (inherited from Control) | Raises the BackColorChanged event when the BackColor property value of the control's container changes.
OnParentBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes.
OnParentBindingContextChanged (inherited from Control) | Raises the BindingContextChanged event when the BindingContext property value of the control's container changes.
OnParentChanged (inherited from Control) | Raises the ParentChanged event.
OnParentEnabledChanged (inherited from Control) | Raises the EnabledChanged event when the Enabled property value of the control's container changes.
OnParentFontChanged (inherited from Control) | Raises the FontChanged event when the Font property value of the control's container changes.
OnParentForeColorChanged (inherited from Control) | Raises the ForeColorChanged event when the ForeColor property value of the control's container changes.
OnParentRightToLeftChanged (inherited from Control) | Raises the RightToLeftChanged event when the RightToLeft property value of the control's container changes.
OnParentVisibleChanged (inherited from Control) | Raises the VisibleChanged event when the Visible property value of the control's container changes.
OnQueryContinueDrag (inherited from Control) | Raises the QueryContinueDrag event.
OnResize (inherited from Form) |
OnRightToLeftChanged (inherited from Control) | Raises the RightToLeftChangedevent.
OnSizeChanged (inherited from Control) | Raises the SizeChanged event.
OnStyleChanged (inherited from Form) |
OnSystemColorsChanged (inherited from Control) | Raises the SystemColorsChanged event.
OnTabIndexChanged (inherited from Control) | Raises the TabIndexChanged event.
OnTabStopChanged (inherited from Control) | Raises the TabStopChanged event.
OnTextChanged (inherited from Form) |
OnValidated (inherited from Control) | Raises the Validated event.
OnValidating (inherited from Control) | Raises the Validating event.
OnVisibleChanged (inherited from Form) |
ProcessCmdKey (inherited from Form) |
ProcessDialogChar (inherited from ContainerControl) |
ProcessDialogKey (inherited from Form) |
ProcessKeyEventArgs (inherited from Control) | Processes a key message and generates the appropriate control events.
ProcessKeyPreview (inherited from Form) |
ProcessMnemonic (inherited from ContainerControl) |
ProcessTabKey (inherited from Form) |
RaiseDragEvent (inherited from Control) |
RaiseKeyEvent (inherited from Control) |
RaiseMouseEvent (inherited from Control) |
RaisePaintEvent (inherited from Control) |
RecreateHandle (inherited from Control) | Forces the re-creation of the handle for the control.
ResetMouseEventArgs (inherited from Control) |
RtlTranslateAlignment (inherited from Control) | Overloaded. Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateContent (inherited from Control) | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
RtlTranslateHorizontal (inherited from Control) | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateLeftRight (inherited from Control) | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
ScaleCore (inherited from Form) |
Select (inherited from Form) | Overloaded.
SetBoundsCore (inherited from Form) |
SetClientSizeCore (inherited from Form) |
SetDisplayRectLocation (inherited from ScrollableControl) |
SetScrollState (inherited from ScrollableControl) |
SetStyle (inherited from Control) | Sets the specified style bit to the specified value.
SetTopLevel (inherited from Control) | Sets the control as the top-level control.
SetVisibleCore (inherited from Form) |
UpdateBounds (inherited from Control) | Overloaded. Updates the bounds of the control with the current size and location.
UpdateDefaultButton (inherited from Form) |
UpdateStyles (inherited from Control) | Forces the assigned styles to be reapplied to the control.
UpdateZOrder (inherited from Control) | Updates the control in its parent's z-order.
WndProc (inherited from Form) |

Protected Internal Instance Methods

ProcessKeyMessage (inherited from Control) Processes a keyboard message.

Explicit Interface Implementations

IContainerControl.ActivateControl (inherited from ContainerControl)

See Also

SimpleEdit Class | NDoc.Core Namespace


SimpleEdit Constructor

Creates a SimpleEdit form.

public SimpleEdit();

See Also

SimpleEdit Class | NDoc.Core Namespace


SimpleEdit Fields

The fields of the SimpleEdit class are listed below. For a complete list of SimpleEdit class members, see the SimpleEdit Members topic.

Public Instance Fields

Value Contains the value of the text box.

See Also

SimpleEdit Class | NDoc.Core Namespace


SimpleEdit.Value Field

Contains the value of the text box.

public string Value;

See Also

SimpleEdit Class | NDoc.Core Namespace


SimpleEdit Methods

The methods of the SimpleEdit class are listed below. For a complete list of SimpleEdit class members, see the SimpleEdit Members topic.

Public Instance Methods

Activate (inherited from Form) | Activates the form and gives it focus.
AddOwnedForm (inherited from Form) | Adds an owned form to this form.
BeginInvoke (inherited from Control) | Overloaded. Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
BringToFront (inherited from Control) | Brings the control to the front of the z-order.
Close (inherited from Form) | Closes the form.
Contains (inherited from Control) | Retrieves a value indicating whether the specified control is a child of the control.
CreateControl (inherited from Control) | Forces the creation of the control, including the creation of the handle and any child controls.
CreateGraphics (inherited from Control) | Creates the Graphics object for the control.
CreateObjRef (inherited from MarshalByRefObject) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose (inherited from Component) | Overloaded. Releases all resources used by the Component.
DoDragDrop (inherited from Control) | Begins a drag-and-drop operation.
EndInvoke (inherited from Control) | Retrieves the return value of the asynchronous operation represented by the IAsyncResult object passed.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
FindForm (inherited from Control) | Retrieves the form that the control is on.
Focus (inherited from Control) | Sets input focus to the control.
GetChildAtPoint (inherited from Control) | Retrieves the child control that is located at the specified coordinates.
GetContainerControl (inherited from Control) | Returns the next ContainerControl up the control's chain of parent controls.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) | Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetNextControl (inherited from Control) | Retrieves the next control forward or back in the tab order of child controls.
GetType (inherited from Object) | Gets the Type of the current instance.
Hide (inherited from Control) | Conceals the control from the user.
InitializeLifetimeService (inherited from MarshalByRefObject) | Obtains a lifetime service object to control the lifetime policy for this instance.
Invalidate (inherited from Control) | Overloaded. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
Invoke (inherited from Control) | Overloaded. Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
LayoutMdi (inherited from Form) | Arranges the multiple document interface (MDI) child forms within the MDI parent form.
PerformLayout (inherited from Control) | Overloaded. Forces the control to apply layout logic to all its child controls.
PointToClient (inherited from Control) | Computes the location of the specified screen point into client coordinates.
PointToScreen (inherited from Control) | Computes the location of the specified client point into screen coordinates.
PreProcessMessage (inherited from Control) | Preprocesses input messages within the message loop before they are dispatched.
RectangleToClient (inherited from Control) | Computes the size and location of the specified screen rectangle in client coordinates.
RectangleToScreen (inherited from Control) | Computes the size and location of the specified client rectangle in screen coordinates.
Refresh (inherited from Control) | Forces the control to invalidate its client area and immediately redraw itself and any child controls.
RemoveOwnedForm (inherited from Form) | Removes an owned form from this form.
ResetBackColor (inherited from Control) | Resets the BackColor property to its default value.
ResetBindings (inherited from Control) | Resets the DataBindings property to its default value.
ResetCursor (inherited from Control) | Resets the Cursor property to its default value.
ResetFont (inherited from Control) | Resets the Fontproperty to its default value.
ResetForeColor (inherited from Control) | Resets the ForeColor property to its default value.
ResetImeMode (inherited from Control) | Resets the ImeMode property to its default value.
ResetRightToLeft (inherited from Control) | Resets the RightToLeft property to its default value.
ResetText (inherited from Control) | Resets the Text property to its default value.
ResumeLayout (inherited from Control) | Overloaded. Resumes normal layout logic.
Scale (inherited from Control) | Overloaded. Scales the control and any child controls to the specified ratio.
ScrollControlIntoView (inherited from ScrollableControl) |
Select (inherited from Control) | Overloaded. Activates the control.
SelectNextControl (inherited from Control) | Activates the next control.
SendToBack (inherited from Control) | Sends the control to the back of the z-order.
SetAutoScrollMargin (inherited from ScrollableControl) | Sets the size of the auto-scroll margins.
SetBounds (inherited from Control) | Overloaded. Sets the bounds of the control to the specified location and size.
SetDesktopBounds (inherited from Form) | Sets the bounds of the form in desktop coordinates.
SetDesktopLocation (inherited from Form) | Sets the location of the form in desktop coordinates.
Show (inherited from Control) | Displays the control to the user.
ShowDialog (inherited from Form) | Overloaded. Shows the form as a modal dialog box with no owner window.
SuspendLayout (inherited from Control) | Temporarily suspends the layout logic for the control.
ToString (inherited from Form) |
Update (inherited from Control) | Causes the control to redraw the invalidated regions within its client area.
Validate (inherited from ContainerControl) | Validates the last invalidated control and its ancestors up through, but not including, the current control.

Protected Instance Methods

AccessibilityNotifyClients (inherited from Control) | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control.
ActivateMdiChild (inherited from Form) |
AdjustFormScrollbars (inherited from Form) |
ApplyAutoScaling (inherited from Form) |
CenterToParent (inherited from Form) |
CenterToScreen (inherited from Form) |
CreateAccessibilityInstance (inherited from Control) | Creates a new accessibility object for the control.
CreateControlsInstance (inherited from Form) |
CreateHandle (inherited from Form) |
DefWndProc (inherited from Form) |
DestroyHandle (inherited from Control) | Destroys the handle associated with the control.
Dispose | Overloaded. Clean up any resources being used.
Finalize (inherited from Component) | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
GetScrollState (inherited from ScrollableControl) |
GetService (inherited from Component) | Returns an object that represents a service provided by the Component or by its Container.
GetStyle (inherited from Control) | Retrieves the value of the specified control style bit for the control.
GetTopLevel (inherited from Control) | Determines if the control is a top-level control.
InitLayout (inherited from Control) | Called after the control has been added to another container.
InvokeGotFocus (inherited from Control) | Raises the GotFocus event for the specified control.
InvokeLostFocus (inherited from Control) | Raises the LostFocus event for the specified control.
InvokeOnClick (inherited from Control) | Raises the Click event for the specified control.
InvokePaint (inherited from Control) | Raises the Paint event for the specified control.
InvokePaintBackground (inherited from Control) | Raises the PaintBackground event for the specified control.
IsInputChar (inherited from Control) | Determines if a character is an input character that the control recognizes.
IsInputKey (inherited from Control) | Determines whether the specified key is a regular input key or a special key that requires preprocessing.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
NotifyInvalidate (inherited from Control) |
OnActivated (inherited from Form) | Raises the Activated event.
OnBackColorChanged (inherited from Control) | Raises the BackColorChanged event.
OnBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event.
OnBindingContextChanged (inherited from Control) | Raises the BindingContextChangedevent.
OnCausesValidationChanged (inherited from Control) | Raises the CausesValidationChangedevent.
OnChangeUICues (inherited from Control) | Raises the ChangeUICues event.
OnClick (inherited from Control) | Raises the Click event.
OnClosed (inherited from Form) | Raises the Closed event.
OnClosing (inherited from Form) | Raises the Closing event.
OnContextMenuChanged (inherited from Control) | Raises the ContextMenuChangedevent.
OnControlAdded (inherited from Control) | Raises the ControlAdded event.
OnControlRemoved (inherited from ContainerControl) |
OnCreateControl (inherited from Form) |
OnCursorChanged (inherited from Control) | Raises the CursorChangedevent.
OnDeactivate (inherited from Form) | Raises the Deactivate event.
OnDockChanged (inherited from Control) | Raises the DockChangedevent.
OnDoubleClick (inherited from Control) | Raises the DoubleClick event.
OnDragDrop (inherited from Control) | Raises the DragDrop event.
OnDragEnter (inherited from Control) | Raises the DragEnter event.
OnDragLeave (inherited from Control) | Raises the DragLeave event.
OnDragOver (inherited from Control) | Raises the DragOver event.
OnEnabledChanged (inherited from Control) | Raises the EnabledChanged event.
OnEnter (inherited from Control) | Raises the Enter event.
OnFontChanged (inherited from Form) |
OnForeColorChanged (inherited from Control) | Raises the ForeColorChangedevent.
OnGiveFeedback (inherited from Control) | Raises the GiveFeedback event.
OnGotFocus (inherited from Control) | Raises the GotFocus event.
OnHandleCreated (inherited from Form) |
OnHandleDestroyed (inherited from Form) |
OnHelpRequested (inherited from Control) | Raises the HelpRequested event.
OnImeModeChanged (inherited from Control) | Raises the ImeModeChanged event.
OnInputLanguageChanged (inherited from Form) | Raises the InputLanguageChanged event.
OnInputLanguageChanging (inherited from Form) | Raises the InputLanguageChanging event.
OnInvalidated (inherited from Control) | Raises the Invalidated event.
OnKeyDown (inherited from Control) | Raises the KeyDown event.
OnKeyPress (inherited from Control) | Raises the KeyPress event.
OnKeyUp (inherited from Control) | Raises the KeyUp event.
OnLayout (inherited from ScrollableControl) |
OnLeave (inherited from Control) | Raises the Leave event.
OnLoad (inherited from Form) | Raises the Load event.
OnLocationChanged (inherited from Control) | Raises the LocationChanged event.
OnLostFocus (inherited from Control) | Raises the LostFocus event.
OnMaximizedBoundsChanged (inherited from Form) | Raises the MaximizedBoundsChanged event.
OnMaximumSizeChanged (inherited from Form) | Raises the MaximumSizeChanged event.
OnMdiChildActivate (inherited from Form) | Raises the MdiChildActivate event.
OnMenuComplete (inherited from Form) | Raises the MenuComplete event.
OnMenuStart (inherited from Form) | Raises the MenuStart event.
OnMinimumSizeChanged (inherited from Form) | Raises the MinimumSizeChanged event.
OnMouseDown (inherited from Control) | Raises the MouseDown event.
OnMouseEnter (inherited from Control) | Raises the MouseEnter event.
OnMouseHover (inherited from Control) | Raises the MouseHover event.
OnMouseLeave (inherited from Control) | Raises the MouseLeave event.
OnMouseMove (inherited from Control) | Raises the MouseMove event.
OnMouseUp (inherited from Control) | Raises the MouseUp event.
OnMouseWheel (inherited from ScrollableControl) |
OnMove (inherited from Control) | Raises the Move event.
OnNotifyMessage (inherited from Control) | Notifies the control of Windows messages.
OnPaint (inherited from Form) |
OnPaintBackground (inherited from Control) | Paints the background of the control.
OnParentBackColorChanged (inherited from Control) | Raises the BackColorChanged event when the BackColor property value of the control's container changes.
OnParentBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes.
OnParentBindingContextChanged (inherited from Control) | Raises the BindingContextChanged event when the BindingContext property value of the control's container changes.
OnParentChanged (inherited from Control) | Raises the ParentChanged event.
OnParentEnabledChanged (inherited from Control) | Raises the EnabledChanged event when the Enabled property value of the control's container changes.
OnParentFontChanged (inherited from Control) | Raises the FontChanged event when the Font property value of the control's container changes.
OnParentForeColorChanged (inherited from Control) | Raises the ForeColorChanged event when the ForeColor property value of the control's container changes.
OnParentRightToLeftChanged (inherited from Control) | Raises the RightToLeftChanged event when the RightToLeft property value of the control's container changes.
OnParentVisibleChanged (inherited from Control) | Raises the VisibleChanged event when the Visible property value of the control's container changes.
OnQueryContinueDrag (inherited from Control) | Raises the QueryContinueDrag event.
OnResize (inherited from Form) |
OnRightToLeftChanged (inherited from Control) | Raises the RightToLeftChangedevent.
OnSizeChanged (inherited from Control) | Raises the SizeChanged event.
OnStyleChanged (inherited from Form) |
OnSystemColorsChanged (inherited from Control) | Raises the SystemColorsChanged event.
OnTabIndexChanged (inherited from Control) | Raises the TabIndexChanged event.
OnTabStopChanged (inherited from Control) | Raises the TabStopChanged event.
OnTextChanged (inherited from Form) |
OnValidated (inherited from Control) | Raises the Validated event.
OnValidating (inherited from Control) | Raises the Validating event.
OnVisibleChanged (inherited from Form) |
ProcessCmdKey (inherited from Form) |
ProcessDialogChar (inherited from ContainerControl) |
ProcessDialogKey (inherited from Form) |
ProcessKeyEventArgs (inherited from Control) | Processes a key message and generates the appropriate control events.
ProcessKeyPreview (inherited from Form) |
ProcessMnemonic (inherited from ContainerControl) |
ProcessTabKey (inherited from Form) |
RaiseDragEvent (inherited from Control) |
RaiseKeyEvent (inherited from Control) |
RaiseMouseEvent (inherited from Control) |
RaisePaintEvent (inherited from Control) |
RecreateHandle (inherited from Control) | Forces the re-creation of the handle for the control.
ResetMouseEventArgs (inherited from Control) |
RtlTranslateAlignment (inherited from Control) | Overloaded. Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateContent (inherited from Control) | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
RtlTranslateHorizontal (inherited from Control) | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateLeftRight (inherited from Control) | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
ScaleCore (inherited from Form) |
Select (inherited from Form) | Overloaded.
SetBoundsCore (inherited from Form) |
SetClientSizeCore (inherited from Form) |
SetDisplayRectLocation (inherited from ScrollableControl) |
SetScrollState (inherited from ScrollableControl) |
SetStyle (inherited from Control) | Sets the specified style bit to the specified value.
SetTopLevel (inherited from Control) | Sets the control as the top-level control.
SetVisibleCore (inherited from Form) |
UpdateBounds (inherited from Control) | Overloaded. Updates the bounds of the control with the current size and location.
UpdateDefaultButton (inherited from Form) |
UpdateStyles (inherited from Control) | Forces the assigned styles to be reapplied to the control.
UpdateZOrder (inherited from Control) | Updates the control in its parent's z-order.
WndProc (inherited from Form) |

Protected Internal Instance Methods

ProcessKeyMessage (inherited from Control) Processes a keyboard message.

Explicit Interface Implementations

IContainerControl.ActivateControl (inherited from ContainerControl)

See Also

SimpleEdit Class | NDoc.Core Namespace


Dispose Method

NDoc Documentation

SimpleEdit.Dispose Method

Clean up any resources being used.

Overload List

Inherited from Component.

public void Dispose();

Clean up any resources being used.

protected override void Dispose(bool);

See Also

SimpleEdit Class | NDoc.Core Namespace


SimpleEdit.Dispose Method (Boolean)

Clean up any resources being used.

protected override void Dispose(
bool disposing
);

See Also

SimpleEdit Class | NDoc.Core Namespace | SimpleEdit.Dispose Overload List


TemplateWriter Class

Stream writer that parses a template file to write a new file.

For a list of all members of this type, see TemplateWriter Members.

System.Object
MarshalByRefObject
TextWriter
StreamWriter
TemplateWriter

public class TemplateWriter : StreamWriter

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

TemplateWriter Members | NDoc.Core Namespace


TemplateWriter Members

TemplateWriter overview

Public Instance Constructors

TemplateWriter Overloaded. Initializes a new instance of the TemplateWriter class.

Public Instance Properties

AutoFlush (inherited from StreamWriter) | Gets or sets a value indicating whether the StreamWriter will flush its buffer to the underlying stream after every call to Write.
BaseStream (inherited from StreamWriter) | Gets the underlying stream that interfaces with a backing store.
Encoding (inherited from StreamWriter) | Gets the Encoding in which the output is written.
FormatProvider (inherited from TextWriter) | Gets an object that controls formatting.
NewLine (inherited from TextWriter) | Gets or sets the line terminator string used by the current TextWriter .

Public Instance Methods

Close | Closes the current StreamWriter and StreamReader.
CopyToEnd | Copies the text lines form the template to the output stream until the end of the template stream.
CopyToLine | Copies the text lines form the template to the output stream until a specific line is found.
CreateObjRef (inherited from MarshalByRefObject) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
Flush (inherited from StreamWriter) | Clears all buffers for the current writer and causes any buffered data to be written to the underlying stream.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) | Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetType (inherited from Object) | Gets the Type of the current instance.
InitializeLifetimeService (inherited from MarshalByRefObject) | Obtains a lifetime service object to control the lifetime policy for this instance.
ToString (inherited from Object) | Returns a String that represents the current Object.
Write (inherited from TextWriter) | Overloaded. Writes out a formatted string, using the same semantics as Format.
Write (inherited from StreamWriter) | Overloaded. Writes a string to the stream.
WriteLine (inherited from TextWriter) | Overloaded. Writes out a formatted string and a new line, using the same semantics as Format.

Protected Instance Fields

CoreNewLine (inherited from TextWriter) Stores the new line characters used for this TextWriter .

Protected Instance Methods

Dispose | Releases the unmanaged resources used by the TemplateWriter and optionally releases the managed resources.
Finalize (inherited from StreamWriter) | Frees the resources of the current StreamWriter before it is reclaimed by the garbage collector.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

Explicit Interface Implementations

IDisposable.Dispose (inherited from TextWriter)

See Also

TemplateWriter Class | NDoc.Core Namespace


TemplateWriter Constructor

Initializes a new instance of the TemplateWriter class for the specified file on the specified path, using the specified template stream and using the default encoding and buffer size.

Overload List

Initializes a new instance of the TemplateWriter class for the specified stream, using the specified template stream and using the default encoding and buffer size.

public TemplateWriter(Stream,TextReader);

Initializes a new instance of the TemplateWriter class for the specified file on the specified path, using the specified template stream and using the default encoding and buffer size.

public TemplateWriter(string,TextReader);

See Also

TemplateWriter Class | NDoc.Core Namespace


TemplateWriter Constructor (String, TextReader)

Initializes a new instance of the TemplateWriter class for the specified file on the specified path, using the specified template stream and using the default encoding and buffer size.

public TemplateWriter(
string outPath,
TextReader template
);

Parameters

outPath
The complete file path to write to.
template
The template's stream reader.

See Also

TemplateWriter Class | NDoc.Core Namespace | TemplateWriter Constructor Overload List


TemplateWriter Constructor (Stream, TextReader)

Initializes a new instance of the TemplateWriter class for the specified stream, using the specified template stream and using the default encoding and buffer size.

public TemplateWriter(
Stream stream,
TextReader template
);

Parameters

stream
The stream to write to.
template
The template's stream reader.

See Also

TemplateWriter Class | NDoc.Core Namespace | TemplateWriter Constructor Overload List


TemplateWriter Methods

The methods of the TemplateWriter class are listed below. For a complete list of TemplateWriter class members, see the TemplateWriter Members topic.

Public Instance Methods

Close | Closes the current StreamWriter and StreamReader.
CopyToEnd | Copies the text lines form the template to the output stream until the end of the template stream.
CopyToLine | Copies the text lines form the template to the output stream until a specific line is found.
CreateObjRef (inherited from MarshalByRefObject) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
Flush (inherited from StreamWriter) | Clears all buffers for the current writer and causes any buffered data to be written to the underlying stream.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) | Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetType (inherited from Object) | Gets the Type of the current instance.
InitializeLifetimeService (inherited from MarshalByRefObject) | Obtains a lifetime service object to control the lifetime policy for this instance.
ToString (inherited from Object) | Returns a String that represents the current Object.
Write (inherited from TextWriter) | Overloaded. Writes out a formatted string, using the same semantics as Format.
Write (inherited from StreamWriter) | Overloaded. Writes a string to the stream.
WriteLine (inherited from TextWriter) | Overloaded. Writes out a formatted string and a new line, using the same semantics as Format.

Protected Instance Methods

Dispose | Releases the unmanaged resources used by the TemplateWriter and optionally releases the managed resources.
Finalize (inherited from StreamWriter) | Frees the resources of the current StreamWriter before it is reclaimed by the garbage collector.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

Explicit Interface Implementations

IDisposable.Dispose (inherited from TextWriter)

See Also

TemplateWriter Class | NDoc.Core Namespace


TemplateWriter.Close Method

Closes the current StreamWriter and StreamReader.

public override void Close();

See Also

TemplateWriter Class | NDoc.Core Namespace


TemplateWriter.CopyToEnd Method

Copies the text lines form the template to the output stream until the end of the template stream.

public void CopyToEnd();

See Also

TemplateWriter Class | NDoc.Core Namespace


TemplateWriter.CopyToLine Method

Copies the text lines form the template to the output stream until a specific line is found.

public bool CopyToLine(
string toLine
);

Parameters

toLine
The line text to search for. Must match exactly.

Return Value

true if the line was found, false if the end of the template stream was reached.

See Also

TemplateWriter Class | NDoc.Core Namespace


TemplateWriter.Dispose Method

Releases the unmanaged resources used by the TemplateWriter and optionally releases the managed resources.

protected override void Dispose(
bool disposing
);

Parameters

disposing
true to release both managed and unmanaged resources; false to release only unmanaged resources.

See Also

TemplateWriter Class | NDoc.Core Namespace


TextEditor Class

Provides editing facilities for large blocks of text in the PropertyGrid.

For a list of all members of this type, see TextEditor Members.

System.Object
UITypeEditor
TextEditor

public class TextEditor : UITypeEditor

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

TextEditor Members | NDoc.Core Namespace


TextEditor Members

TextEditor overview

Public Instance Constructors

TextEditor Constructor Creates a new instance of the TextEditor class.

Public Instance Methods

EditValue | Overloaded. Edits the specified object's value using the editor style indicated by GetEditStyle.
EditValue (inherited from UITypeEditor) | Overloaded. Edits the value of the specified object using the editor style indicated by GetEditStyle.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetEditStyle | Overloaded. Gets the editor style used by the EditValue method.
GetEditStyle (inherited from UITypeEditor) | Overloaded. Gets the editor style used by the EditValue method.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetPaintValueSupported (inherited from UITypeEditor) | Overloaded. Indicates whether the specified context supports painting a representation of an object's value within the specified context.
GetType (inherited from Object) | Gets the Type of the current instance.
PaintValue (inherited from UITypeEditor) | Overloaded. Paints a representation of the value of an object using the specified PaintValueEventArgs.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

TextEditor Class | NDoc.Core Namespace


TextEditor Constructor

Creates a new instance of the TextEditor class.

public TextEditor();

See Also

TextEditor Class | NDoc.Core Namespace


TextEditor Methods

The methods of the TextEditor class are listed below. For a complete list of TextEditor class members, see the TextEditor Members topic.

Public Instance Methods

EditValue | Overloaded. Edits the specified object's value using the editor style indicated by GetEditStyle.
EditValue (inherited from UITypeEditor) | Overloaded. Edits the value of the specified object using the editor style indicated by GetEditStyle.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetEditStyle | Overloaded. Gets the editor style used by the EditValue method.
GetEditStyle (inherited from UITypeEditor) | Overloaded. Gets the editor style used by the EditValue method.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetPaintValueSupported (inherited from UITypeEditor) | Overloaded. Indicates whether the specified context supports painting a representation of an object's value within the specified context.
GetType (inherited from Object) | Gets the Type of the current instance.
PaintValue (inherited from UITypeEditor) | Overloaded. Paints a representation of the value of an object using the specified PaintValueEventArgs.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

TextEditor Class | NDoc.Core Namespace


EditValue Method

NDoc Documentation

TextEditor.EditValue Method

Edits the specified object's value using the editor style indicated by GetEditStyle.

Overload List

Edits the specified object's value using the editor style indicated by GetEditStyle.

public override object EditValue(ITypeDescriptorContext,IServiceProvider,object);

Inherited from UITypeEditor.

public object EditValue(IServiceProvider,object);

See Also

TextEditor Class | NDoc.Core Namespace


TextEditor.EditValue Method (ITypeDescriptorContext, IServiceProvider, Object)

Edits the specified object's value using the editor style indicated by GetEditStyle.

public override object EditValue(
ITypeDescriptorContext context,
IServiceProvider provider,
object value
);

Parameters

context
An ITypeDescriptorContext that can be used to gain additional context information.
provider
An IServiceProvider that this editor can use to obtain services.
value
The object to edit.

Return Value

The new value of the object.

See Also

TextEditor Class | NDoc.Core Namespace | TextEditor.EditValue Overload List


GetEditStyle Method

NDoc Documentation

TextEditor.GetEditStyle Method

Gets the editor style used by the EditValue method.

Overload List

Inherited from UITypeEditor.

public UITypeEditorEditStyle GetEditStyle();

Gets the editor style used by the EditValue method.

public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext);

See Also

TextEditor Class | NDoc.Core Namespace


TextEditor.GetEditStyle Method (ITypeDescriptorContext)

Gets the editor style used by the EditValue method.

public override UITypeEditorEditStyle GetEditStyle(
ITypeDescriptorContext context
);

Parameters

context
An ITypeDescriptorContext that can be used to gain additional context information.

Return Value

A UITypeEditorEditStyle value that indicates the style of editor used by EditValue.

See Also

TextEditor Class | NDoc.Core Namespace | TextEditor.GetEditStyle Overload List


TextEditorForm Class

Used in the conjunction with the TextEditor, this form provides the user a larger interface with which to edit text.

For a list of all members of this type, see TextEditorForm Members.

System.Object
MarshalByRefObject
Component
Control
ScrollableControl
ContainerControl
Form
TextEditorForm

public class TextEditorForm : Form

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

TextEditorForm Members | NDoc.Core Namespace


TextEditorForm Members

TextEditorForm overview

Public Instance Constructors

TextEditorForm Constructor Creates a new instance of the TextEditorForm class.

Public Instance Properties

AcceptButton (inherited from Form) | Gets or sets the button on the form that is clicked when the user presses the ENTER key.
AccessibilityObject (inherited from Control) | Gets the AccessibleObject assigned to the control.
AccessibleDefaultActionDescription (inherited from Control) | Gets or sets the default action description of the control for use by accessibility client applications.
AccessibleDescription (inherited from Control) | Gets or sets the description of the control used by accessibility client applications.
AccessibleName (inherited from Control) | Gets or sets the name of the control used by accessibility client applications.
AccessibleRole (inherited from Control) | Gets or sets the accessible role of the control
ActiveControl (inherited from ContainerControl) | Gets or sets the active control on the container control.
ActiveMdiChild (inherited from Form) | Gets the currently active multiple document interface (MDI) child window.
AllowDrop (inherited from Control) | Gets or sets a value indicating whether the control can accept data that the user drags onto it.
AllowTransparency (inherited from Form) |
Anchor (inherited from Control) | Gets or sets which edges of the control are anchored to the edges of its container.
AutoScale (inherited from Form) | Gets or sets a value indicating whether the form adjusts its size to fit the height of the font used on the form and scales its controls.
AutoScaleBaseSize (inherited from Form) | Gets or sets the base size used for autoscaling of the form.
AutoScroll (inherited from Form) | Gets or sets a value indicating whether the form enables autoscrolling.
AutoScrollMargin (inherited from ScrollableControl) | Gets or sets the size of the auto-scroll margin.
AutoScrollMinSize (inherited from ScrollableControl) | Gets or sets the minimum size of the auto-scroll.
AutoScrollPosition (inherited from ScrollableControl) | Gets or sets the location of the auto-scroll position.
BackColor (inherited from Form) |
BackgroundImage (inherited from Control) | Gets or sets the background image displayed in the control.
BindingContext (inherited from ContainerControl) |
Bottom (inherited from Control) | Gets the distance between the bottom edge of the control and the top edge of its container's client area.
Bounds (inherited from Control) | Gets or sets the size and location of the control including its nonclient elements.
CancelButton (inherited from Form) | Gets or sets the button control that is clicked when the user presses the ESC key.
CanFocus (inherited from Control) | Gets a value indicating whether the control can receive focus.
CanSelect (inherited from Control) | Gets a value indicating whether the control can be selected.
Capture (inherited from Control) | Gets or sets a value indicating whether the control has captured the mouse.
CausesValidation (inherited from Control) | Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
ClientRectangle (inherited from Control) | Gets the rectangle that represents the client area of the control.
ClientSize (inherited from Form) | Gets or sets the size of the client area of the form.
CompanyName (inherited from Control) | Gets the name of the company or creator of the application containing the control.
Container (inherited from Component) | Gets the IContainer that contains the Component.
ContainsFocus (inherited from Control) | Gets a value indicating whether the control, or one of its child controls, currently has the input focus.
ContextMenu (inherited from Control) | Gets or sets the shortcut menu associated with the control.
ControlBox (inherited from Form) | Gets or sets a value indicating whether a control box is displayed in the caption bar of the form.
Controls (inherited from Control) | Gets the collection of controls contained within the control.
Created (inherited from Control) | Gets a value indicating whether the control has been created.
Cursor (inherited from Control) | Gets or sets the cursor that is displayed when the mouse pointer is over the control.
DataBindings (inherited from Control) | Gets the data bindings for the control.
DesktopBounds (inherited from Form) | Gets or sets the size and location of the form on the Windows desktop.
DesktopLocation (inherited from Form) | Gets or sets the location of the form on the Windows desktop.
DialogResult (inherited from Form) | Gets or sets the dialog result for the form.
DisplayRectangle (inherited from ScrollableControl) |
Disposing (inherited from Control) | Gets a value indicating whether the control is in the process of being disposed of.
Dock (inherited from Control) | Gets or sets which edge of the parent container a control is docked to.
DockPadding (inherited from ScrollableControl) | Gets the dock padding settings for all edges of the control.
Enabled (inherited from Control) | Gets or sets a value indicating whether the control can respond to user interaction.
Focused (inherited from Control) | Gets a value indicating whether the control has input focus.
Font (inherited from Control) | Gets or sets the font of the text displayed by the control.
ForeColor (inherited from Control) | Gets or sets the foreground color of the control.
FormBorderStyle (inherited from Form) | Gets or sets the border style of the form.
Handle (inherited from Control) | Gets the window handle that the control is bound to.
HasChildren (inherited from Control) | Gets a value indicating whether the control contains one or more child controls.
Height (inherited from Control) | Gets or sets the height of the control.
HelpButton (inherited from Form) | Gets or sets a value indicating whether a Help button should be displayed in the caption box of the form.
Icon (inherited from Form) | Gets or sets the icon for the form.
ImeMode (inherited from Control) | Gets or sets the Input Method Editor (IME) mode of the control.
InvokeRequired (inherited from Control) | Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on.
IsAccessible (inherited from Control) | Gets or sets a value indicating whether the control is visible to accessibility applications.
IsDisposed (inherited from Control) | Gets a value indicating whether the control has been disposed of.
IsHandleCreated (inherited from Control) | Gets a value indicating whether the control has a handle associated with it.
IsMdiChild (inherited from Form) | Gets a value indicating whether the form is a multiple document interface (MDI) child form.
IsMdiContainer (inherited from Form) | Gets or sets a value indicating whether the form is a container for multiple document interface (MDI) child forms.
IsRestrictedWindow (inherited from Form) |
KeyPreview (inherited from Form) | Gets or sets a value indicating whether the form will receive key events before the event is passed to the control that has focus.
Left (inherited from Control) | Gets or sets the x-coordinate of a control's left edge in pixels.
Location (inherited from Control) | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
MaximizeBox (inherited from Form) | Gets or sets a value indicating whether the maximize button is displayed in the caption bar of the form.
MaximumSize (inherited from Form) | Gets the maximum size the form can be resized to.
MdiChildren (inherited from Form) | Gets an array of forms that represent the multiple document interface (MDI) child forms that are parented to this form.
MdiParent (inherited from Form) | Gets or sets the current multiple document interface (MDI) parent form of this form.
Menu (inherited from Form) | Gets or sets the MainMenu that is displayed in the form.
MergedMenu (inherited from Form) | Gets the merged menu for the form.
MinimizeBox (inherited from Form) | Gets or sets a value indicating whether the minimize button is displayed in the caption bar of the form.
MinimumSize (inherited from Form) | Gets or sets the minimum size the form can be resized to.
Modal (inherited from Form) | Gets a value indicating whether this form is displayed modally.
Name (inherited from Control) | Gets or sets the name of the control.
Opacity (inherited from Form) | Gets or sets the opacity level of the form.
OwnedForms (inherited from Form) | Gets an array of Form objects that represent all forms that are owned by this form.
Owner (inherited from Form) | Gets or sets the form that owns this form.
Parent (inherited from Control) | Gets or sets the parent container of the control.
ParentForm (inherited from ContainerControl) | Gets the form that the container control is assigned to.
ProductName (inherited from Control) | Gets the product name of the assembly containing the control.
ProductVersion (inherited from Control) | Gets the version of the assembly containing the control.
RecreatingHandle (inherited from Control) | Gets a value indicating whether the control is currently re-creating its handle.
Region (inherited from Control) | Gets or sets the window region associated with the control.
Right (inherited from Control) | Gets the distance between the right edge of the control and the left edge of its container.
RightToLeft (inherited from Control) | Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
ShowInTaskbar (inherited from Form) | Gets or sets a value indicating whether the form is displayed in the Windows taskbar.
Site (inherited from Control) | Gets or sets the site of the control.
Size (inherited from Form) | Gets or sets the size of the form.
SizeGripStyle (inherited from Form) | Gets or sets the style of the size grip to display in the lower-right corner of the form.
StartPosition (inherited from Form) | Gets or sets the starting position of the form at run time.
TabIndex (inherited from Form) |
TabStop (inherited from Control) | Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
Tag (inherited from Control) | Gets or sets the object that contains data about the control.
Text (inherited from Control) | Gets or sets the text associated with this control.
Top (inherited from Control) | Gets or sets the y-coordinate of the control's top edge in pixels.
TopLevel (inherited from Form) | Gets or sets a value indicating whether to display the form as a top-level window.
TopLevelControl (inherited from Control) | Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
TopMost (inherited from Form) | Gets or sets a value indicating whether the form should be displayed as the top-most form of your application.
TransparencyKey (inherited from Form) | Gets or sets the color that will represent transparent areas of the form.
Value | Gets or sets the text to edit.
Visible (inherited from Control) | Gets or sets a value indicating whether the control is displayed.
Width (inherited from Control) | Gets or sets the width of the control.
WindowState (inherited from Form) | Gets or sets the form's window state.
WindowTarget (inherited from Control) |

Public Instance Methods

Activate (inherited from Form) | Activates the form and gives it focus.
AddOwnedForm (inherited from Form) | Adds an owned form to this form.
BeginInvoke (inherited from Control) | Overloaded. Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
BringToFront (inherited from Control) | Brings the control to the front of the z-order.
Close (inherited from Form) | Closes the form.
Contains (inherited from Control) | Retrieves a value indicating whether the specified control is a child of the control.
CreateControl (inherited from Control) | Forces the creation of the control, including the creation of the handle and any child controls.
CreateGraphics (inherited from Control) | Creates the Graphics object for the control.
CreateObjRef (inherited from MarshalByRefObject) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose (inherited from Component) | Overloaded. Releases all resources used by the Component.
DoDragDrop (inherited from Control) | Begins a drag-and-drop operation.
EndInvoke (inherited from Control) | Retrieves the return value of the asynchronous operation represented by the IAsyncResult object passed.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
FindForm (inherited from Control) | Retrieves the form that the control is on.
Focus (inherited from Control) | Sets input focus to the control.
GetChildAtPoint (inherited from Control) | Retrieves the child control that is located at the specified coordinates.
GetContainerControl (inherited from Control) | Returns the next ContainerControl up the control's chain of parent controls.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) | Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetNextControl (inherited from Control) | Retrieves the next control forward or back in the tab order of child controls.
GetType (inherited from Object) | Gets the Type of the current instance.
Hide (inherited from Control) | Conceals the control from the user.
InitializeLifetimeService (inherited from MarshalByRefObject) | Obtains a lifetime service object to control the lifetime policy for this instance.
Invalidate (inherited from Control) | Overloaded. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
Invoke (inherited from Control) | Overloaded. Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
LayoutMdi (inherited from Form) | Arranges the multiple document interface (MDI) child forms within the MDI parent form.
PerformLayout (inherited from Control) | Overloaded. Forces the control to apply layout logic to all its child controls.
PointToClient (inherited from Control) | Computes the location of the specified screen point into client coordinates.
PointToScreen (inherited from Control) | Computes the location of the specified client point into screen coordinates.
PreProcessMessage (inherited from Control) | Preprocesses input messages within the message loop before they are dispatched.
RectangleToClient (inherited from Control) | Computes the size and location of the specified screen rectangle in client coordinates.
RectangleToScreen (inherited from Control) | Computes the size and location of the specified client rectangle in screen coordinates.
Refresh (inherited from Control) | Forces the control to invalidate its client area and immediately redraw itself and any child controls.
RemoveOwnedForm (inherited from Form) | Removes an owned form from this form.
ResetBackColor (inherited from Control) | Resets the BackColor property to its default value.
ResetBindings (inherited from Control) | Resets the DataBindings property to its default value.
ResetCursor (inherited from Control) | Resets the Cursor property to its default value.
ResetFont (inherited from Control) | Resets the Fontproperty to its default value.
ResetForeColor (inherited from Control) | Resets the ForeColor property to its default value.
ResetImeMode (inherited from Control) | Resets the ImeMode property to its default value.
ResetRightToLeft (inherited from Control) | Resets the RightToLeft property to its default value.
ResetText (inherited from Control) | Resets the Text property to its default value.
ResumeLayout (inherited from Control) | Overloaded. Resumes normal layout logic.
Scale (inherited from Control) | Overloaded. Scales the control and any child controls to the specified ratio.
ScrollControlIntoView (inherited from ScrollableControl) |
Select (inherited from Control) | Overloaded. Activates the control.
SelectNextControl (inherited from Control) | Activates the next control.
SendToBack (inherited from Control) | Sends the control to the back of the z-order.
SetAutoScrollMargin (inherited from ScrollableControl) | Sets the size of the auto-scroll margins.
SetBounds (inherited from Control) | Overloaded. Sets the bounds of the control to the specified location and size.
SetDesktopBounds (inherited from Form) | Sets the bounds of the form in desktop coordinates.
SetDesktopLocation (inherited from Form) | Sets the location of the form in desktop coordinates.
Show (inherited from Control) | Displays the control to the user.
ShowDialog (inherited from Form) | Overloaded. Shows the form as a modal dialog box with no owner window.
SuspendLayout (inherited from Control) | Temporarily suspends the layout logic for the control.
ToString (inherited from Form) |
Update (inherited from Control) | Causes the control to redraw the invalidated regions within its client area.
Validate (inherited from ContainerControl) | Validates the last invalidated control and its ancestors up through, but not including, the current control.

Public Instance Events

Activated (inherited from Form) | Occurs when the form is activated in code or by the user.
BackColorChanged (inherited from Control) | Occurs when the value of the BackColor property changes.
BackgroundImageChanged (inherited from Control) | Occurs when the value of the BackgroundImage property changes.
BindingContextChanged (inherited from Control) | Occurs when the value of the BindingContext property changes.
CausesValidationChanged (inherited from Control) | Occurs when the value of the CausesValidation property changes.
ChangeUICues (inherited from Control) | Occurs when the focus or keyboard user interface (UI) cues change.
Click (inherited from Control) | Occurs when the control is clicked.
Closed (inherited from Form) | Occurs when the form is closed.
Closing (inherited from Form) | Occurs when the form is closing.
ContextMenuChanged (inherited from Control) | Occurs when the value of the ContextMenu property changes.
ControlAdded (inherited from Control) | Occurs when a new control is added to the ControlCollection .
ControlRemoved (inherited from Control) | Occurs when a control is removed from the ControlCollection .
CursorChanged (inherited from Control) | Occurs when the value of the Cursor property changes.
Deactivate (inherited from Form) | Occurs when the form loses focus and is not the active form.
Disposed (inherited from Component) | Adds an event handler to listen to the Disposed event on the component.
DockChanged (inherited from Control) | Occurs when the value of the Dock property changes.
DoubleClick (inherited from Control) | Occurs when the control is double-clicked.
DragDrop (inherited from Control) | Occurs when a drag-and-drop operation is completed.
DragEnter (inherited from Control) | Occurs when an object is dragged into the control's bounds.
DragLeave (inherited from Control) | Occurs when an object is dragged out of the control's bounds.
DragOver (inherited from Control) | Occurs when an object is dragged over the control's bounds.
EnabledChanged (inherited from Control) | Occurs when the Enabled property value has changed.
Enter (inherited from Control) | Occurs when the control is entered.
FontChanged (inherited from Control) | Occurs when the Font property value changes.
ForeColorChanged (inherited from Control) | Occurs when the ForeColor property value changes.
GiveFeedback (inherited from Control) | Occurs during a drag operation.
GotFocus (inherited from Control) | Occurs when the control receives focus.
HandleCreated (inherited from Control) | Occurs when a handle is created for the control.
HandleDestroyed (inherited from Control) | Occurs when the control's handle is in the process of being destroyed.
HelpRequested (inherited from Control) | Occurs when the user requests help for a control.
ImeModeChanged (inherited from Control) | Occurs when the ImeMode property has changed.
InputLanguageChanged (inherited from Form) | Occurs after the input language of the form has changed.
InputLanguageChanging (inherited from Form) | Occurs when the user attempts to change the input language for the form.
Invalidated (inherited from Control) | Occurs when a control's display requires redrawing.
KeyDown (inherited from Control) | Occurs when a key is pressed while the control has focus.
KeyPress (inherited from Control) | Occurs when a key is pressed while the control has focus.
KeyUp (inherited from Control) | Occurs when a key is released while the control has focus.
Layout (inherited from Control) | Occurs when a control should reposition its child controls.
Leave (inherited from Control) | Occurs when the input focus leaves the control.
Load (inherited from Form) | Occurs before a form is displayed for the first time.
LocationChanged (inherited from Control) | Occurs when the Location property value has changed.
LostFocus (inherited from Control) | Occurs when the control loses focus.
MaximizedBoundsChanged (inherited from Form) | Occurs when the value of the MaximizedBounds property has changed.
MaximumSizeChanged (inherited from Form) | Occurs when the value of the MaximumSize property has changed.
MdiChildActivate (inherited from Form) | Occurs when a multiple document interface (MDI) child form is activated or closed within an MDI application.
MenuComplete (inherited from Form) | Occurs when the menu of a form loses focus.
MenuStart (inherited from Form) | Occurs when the menu of a form receives focus.
MinimumSizeChanged (inherited from Form) | Occurs when the value of the MinimumSize property has changed.
MouseDown (inherited from Control) | Occurs when the mouse pointer is over the control and a mouse button is pressed.
MouseEnter (inherited from Control) | Occurs when the mouse pointer enters the control.
MouseHover (inherited from Control) | Occurs when the mouse pointer hovers over the control.
MouseLeave (inherited from Control) | Occurs when the mouse pointer leaves the control.
MouseMove (inherited from Control) | Occurs when the mouse pointer is moved over the control.
MouseUp (inherited from Control) | Occurs when the mouse pointer is over the control and a mouse button is released.
MouseWheel (inherited from Control) | Occurs when the mouse wheel moves while the control has focus.
Move (inherited from Control) | Occurs when the control is moved.
Paint (inherited from Control) | Occurs when the control is redrawn.
ParentChanged (inherited from Control) | Occurs when the Parent property value changes.
QueryAccessibilityHelp (inherited from Control) | Occurs when AccessibleObject is providing help to accessibility applications.
QueryContinueDrag (inherited from Control) | Occurs during a drag-and-drop operation and allows the drag source to determine whether the drag-and-drop operation should be canceled.
Resize (inherited from Control) | Occurs when the control is resized.
RightToLeftChanged (inherited from Control) | Occurs when the RightToLeft property value changes.
SizeChanged (inherited from Control) | Occurs when the Size property value changes.
StyleChanged (inherited from Control) | Occurs when the control style changes.
SystemColorsChanged (inherited from Control) | Occurs when the system colors change.
TabIndexChanged (inherited from Form) |
TabStopChanged (inherited from Control) | Occurs when the TabStop property value changes.
TextChanged (inherited from Control) | Occurs when the Text property value changes.
Validated (inherited from Control) | Occurs when the control is finished validating.
Validating (inherited from Control) | Occurs when the control is validating.
VisibleChanged (inherited from Control) | Occurs when the Visible property value changes.

Protected Instance Properties

CreateParams (inherited from Form) |
DefaultImeMode (inherited from Form) | Gets the default Input Method Editor (IME) mode supported by the control.
DefaultSize (inherited from Form) |
DesignMode (inherited from Component) | Gets a value that indicates whether the Component is currently in design mode.
Events (inherited from Component) | Gets the list of event handlers that are attached to this Component.
FontHeight (inherited from Control) | Gets or sets the height of the font of the control.
HScroll (inherited from ScrollableControl) | Gets or sets a value indicating whether the horizontal scroll bar is visible.
MaximizedBounds (inherited from Form) | Gets and sets the size of the form when it is maximized.
RenderRightToLeft (inherited from Control) |
ResizeRedraw (inherited from Control) | Gets or sets a value indicating whether the control redraws itself when resized.
ShowFocusCues (inherited from Control) | Gets a value indicating whether the control should display focus rectangles.
ShowKeyboardCues (inherited from Control) | Gets a value indicating whether the control should display keyboard shortcuts.
VScroll (inherited from ScrollableControl) | Gets or sets a value indicating whether the vertical scroll bar is visible.

Protected Instance Methods

AccessibilityNotifyClients (inherited from Control) | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control.
ActivateMdiChild (inherited from Form) |
AdjustFormScrollbars (inherited from Form) |
ApplyAutoScaling (inherited from Form) |
CenterToParent (inherited from Form) |
CenterToScreen (inherited from Form) |
CreateAccessibilityInstance (inherited from Control) | Creates a new accessibility object for the control.
CreateControlsInstance (inherited from Form) |
CreateHandle (inherited from Form) |
DefWndProc (inherited from Form) |
DestroyHandle (inherited from Control) | Destroys the handle associated with the control.
Dispose | Overloaded. Clean up any resources being used.
Finalize (inherited from Component) | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
GetScrollState (inherited from ScrollableControl) |
GetService (inherited from Component) | Returns an object that represents a service provided by the Component or by its Container.
GetStyle (inherited from Control) | Retrieves the value of the specified control style bit for the control.
GetTopLevel (inherited from Control) | Determines if the control is a top-level control.
InitLayout (inherited from Control) | Called after the control has been added to another container.
InvokeGotFocus (inherited from Control) | Raises the GotFocus event for the specified control.
InvokeLostFocus (inherited from Control) | Raises the LostFocus event for the specified control.
InvokeOnClick (inherited from Control) | Raises the Click event for the specified control.
InvokePaint (inherited from Control) | Raises the Paint event for the specified control.
InvokePaintBackground (inherited from Control) | Raises the PaintBackground event for the specified control.
IsInputChar (inherited from Control) | Determines if a character is an input character that the control recognizes.
IsInputKey (inherited from Control) | Determines whether the specified key is a regular input key or a special key that requires preprocessing.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
NotifyInvalidate (inherited from Control) |
OnActivated (inherited from Form) | Raises the Activated event.
OnBackColorChanged (inherited from Control) | Raises the BackColorChanged event.
OnBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event.
OnBindingContextChanged (inherited from Control) | Raises the BindingContextChangedevent.
OnCausesValidationChanged (inherited from Control) | Raises the CausesValidationChangedevent.
OnChangeUICues (inherited from Control) | Raises the ChangeUICues event.
OnClick (inherited from Control) | Raises the Click event.
OnClosed (inherited from Form) | Raises the Closed event.
OnClosing (inherited from Form) | Raises the Closing event.
OnContextMenuChanged (inherited from Control) | Raises the ContextMenuChangedevent.
OnControlAdded (inherited from Control) | Raises the ControlAdded event.
OnControlRemoved (inherited from ContainerControl) |
OnCreateControl (inherited from Form) |
OnCursorChanged (inherited from Control) | Raises the CursorChangedevent.
OnDeactivate (inherited from Form) | Raises the Deactivate event.
OnDockChanged (inherited from Control) | Raises the DockChangedevent.
OnDoubleClick (inherited from Control) | Raises the DoubleClick event.
OnDragDrop (inherited from Control) | Raises the DragDrop event.
OnDragEnter (inherited from Control) | Raises the DragEnter event.
OnDragLeave (inherited from Control) | Raises the DragLeave event.
OnDragOver (inherited from Control) | Raises the DragOver event.
OnEnabledChanged (inherited from Control) | Raises the EnabledChanged event.
OnEnter (inherited from Control) | Raises the Enter event.
OnFontChanged (inherited from Form) |
OnForeColorChanged (inherited from Control) | Raises the ForeColorChangedevent.
OnGiveFeedback (inherited from Control) | Raises the GiveFeedback event.
OnGotFocus (inherited from Control) | Raises the GotFocus event.
OnHandleCreated (inherited from Form) |
OnHandleDestroyed (inherited from Form) |
OnHelpRequested (inherited from Control) | Raises the HelpRequested event.
OnImeModeChanged (inherited from Control) | Raises the ImeModeChanged event.
OnInputLanguageChanged (inherited from Form) | Raises the InputLanguageChanged event.
OnInputLanguageChanging (inherited from Form) | Raises the InputLanguageChanging event.
OnInvalidated (inherited from Control) | Raises the Invalidated event.
OnKeyDown (inherited from Control) | Raises the KeyDown event.
OnKeyPress (inherited from Control) | Raises the KeyPress event.
OnKeyUp (inherited from Control) | Raises the KeyUp event.
OnLayout (inherited from ScrollableControl) |
OnLeave (inherited from Control) | Raises the Leave event.
OnLoad (inherited from Form) | Raises the Load event.
OnLocationChanged (inherited from Control) | Raises the LocationChanged event.
OnLostFocus (inherited from Control) | Raises the LostFocus event.
OnMaximizedBoundsChanged (inherited from Form) | Raises the MaximizedBoundsChanged event.
OnMaximumSizeChanged (inherited from Form) | Raises the MaximumSizeChanged event.
OnMdiChildActivate (inherited from Form) | Raises the MdiChildActivate event.
OnMenuComplete (inherited from Form) | Raises the MenuComplete event.
OnMenuStart (inherited from Form) | Raises the MenuStart event.
OnMinimumSizeChanged (inherited from Form) | Raises the MinimumSizeChanged event.
OnMouseDown (inherited from Control) | Raises the MouseDown event.
OnMouseEnter (inherited from Control) | Raises the MouseEnter event.
OnMouseHover (inherited from Control) | Raises the MouseHover event.
OnMouseLeave (inherited from Control) | Raises the MouseLeave event.
OnMouseMove (inherited from Control) | Raises the MouseMove event.
OnMouseUp (inherited from Control) | Raises the MouseUp event.
OnMouseWheel (inherited from ScrollableControl) |
OnMove (inherited from Control) | Raises the Move event.
OnNotifyMessage (inherited from Control) | Notifies the control of Windows messages.
OnPaint (inherited from Form) |
OnPaintBackground (inherited from Control) | Paints the background of the control.
OnParentBackColorChanged (inherited from Control) | Raises the BackColorChanged event when the BackColor property value of the control's container changes.
OnParentBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes.
OnParentBindingContextChanged (inherited from Control) | Raises the BindingContextChanged event when the BindingContext property value of the control's container changes.
OnParentChanged (inherited from Control) | Raises the ParentChanged event.
OnParentEnabledChanged (inherited from Control) | Raises the EnabledChanged event when the Enabled property value of the control's container changes.
OnParentFontChanged (inherited from Control) | Raises the FontChanged event when the Font property value of the control's container changes.
OnParentForeColorChanged (inherited from Control) | Raises the ForeColorChanged event when the ForeColor property value of the control's container changes.
OnParentRightToLeftChanged (inherited from Control) | Raises the RightToLeftChanged event when the RightToLeft property value of the control's container changes.
OnParentVisibleChanged (inherited from Control) | Raises the VisibleChanged event when the Visible property value of the control's container changes.
OnQueryContinueDrag (inherited from Control) | Raises the QueryContinueDrag event.
OnResize (inherited from Form) |
OnRightToLeftChanged (inherited from Control) | Raises the RightToLeftChangedevent.
OnSizeChanged (inherited from Control) | Raises the SizeChanged event.
OnStyleChanged (inherited from Form) |
OnSystemColorsChanged (inherited from Control) | Raises the SystemColorsChanged event.
OnTabIndexChanged (inherited from Control) | Raises the TabIndexChanged event.
OnTabStopChanged (inherited from Control) | Raises the TabStopChanged event.
OnTextChanged (inherited from Form) |
OnValidated (inherited from Control) | Raises the Validated event.
OnValidating (inherited from Control) | Raises the Validating event.
OnVisibleChanged (inherited from Form) |
ProcessCmdKey (inherited from Form) |
ProcessDialogChar (inherited from ContainerControl) |
ProcessDialogKey (inherited from Form) |
ProcessKeyEventArgs (inherited from Control) | Processes a key message and generates the appropriate control events.
ProcessKeyPreview (inherited from Form) |
ProcessMnemonic (inherited from ContainerControl) |
ProcessTabKey (inherited from Form) |
RaiseDragEvent (inherited from Control) |
RaiseKeyEvent (inherited from Control) |
RaiseMouseEvent (inherited from Control) |
RaisePaintEvent (inherited from Control) |
RecreateHandle (inherited from Control) | Forces the re-creation of the handle for the control.
ResetMouseEventArgs (inherited from Control) |
RtlTranslateAlignment (inherited from Control) | Overloaded. Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateContent (inherited from Control) | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
RtlTranslateHorizontal (inherited from Control) | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateLeftRight (inherited from Control) | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
ScaleCore (inherited from Form) |
Select (inherited from Form) | Overloaded.
SetBoundsCore (inherited from Form) |
SetClientSizeCore (inherited from Form) |
SetDisplayRectLocation (inherited from ScrollableControl) |
SetScrollState (inherited from ScrollableControl) |
SetStyle (inherited from Control) | Sets the specified style bit to the specified value.
SetTopLevel (inherited from Control) | Sets the control as the top-level control.
SetVisibleCore (inherited from Form) |
UpdateBounds (inherited from Control) | Overloaded. Updates the bounds of the control with the current size and location.
UpdateDefaultButton (inherited from Form) |
UpdateStyles (inherited from Control) | Forces the assigned styles to be reapplied to the control.
UpdateZOrder (inherited from Control) | Updates the control in its parent's z-order.
WndProc (inherited from Form) |

Protected Internal Instance Methods

ProcessKeyMessage (inherited from Control) Processes a keyboard message.

Explicit Interface Implementations

IContainerControl.ActivateControl (inherited from ContainerControl)

See Also

TextEditorForm Class | NDoc.Core Namespace


TextEditorForm Constructor

Creates a new instance of the TextEditorForm class.

public TextEditorForm();

See Also

TextEditorForm Class | NDoc.Core Namespace


TextEditorForm Properties

The properties of the TextEditorForm class are listed below. For a complete list of TextEditorForm class members, see the TextEditorForm Members topic.

Public Instance Properties

AcceptButton (inherited from Form) | Gets or sets the button on the form that is clicked when the user presses the ENTER key.
AccessibilityObject (inherited from Control) | Gets the AccessibleObject assigned to the control.
AccessibleDefaultActionDescription (inherited from Control) | Gets or sets the default action description of the control for use by accessibility client applications.
AccessibleDescription (inherited from Control) | Gets or sets the description of the control used by accessibility client applications.
AccessibleName (inherited from Control) | Gets or sets the name of the control used by accessibility client applications.
AccessibleRole (inherited from Control) | Gets or sets the accessible role of the control
ActiveControl (inherited from ContainerControl) | Gets or sets the active control on the container control.
ActiveMdiChild (inherited from Form) | Gets the currently active multiple document interface (MDI) child window.
AllowDrop (inherited from Control) | Gets or sets a value indicating whether the control can accept data that the user drags onto it.
AllowTransparency (inherited from Form) |
Anchor (inherited from Control) | Gets or sets which edges of the control are anchored to the edges of its container.
AutoScale (inherited from Form) | Gets or sets a value indicating whether the form adjusts its size to fit the height of the font used on the form and scales its controls.
AutoScaleBaseSize (inherited from Form) | Gets or sets the base size used for autoscaling of the form.
AutoScroll (inherited from Form) | Gets or sets a value indicating whether the form enables autoscrolling.
AutoScrollMargin (inherited from ScrollableControl) | Gets or sets the size of the auto-scroll margin.
AutoScrollMinSize (inherited from ScrollableControl) | Gets or sets the minimum size of the auto-scroll.
AutoScrollPosition (inherited from ScrollableControl) | Gets or sets the location of the auto-scroll position.
BackColor (inherited from Form) |
BackgroundImage (inherited from Control) | Gets or sets the background image displayed in the control.
BindingContext (inherited from ContainerControl) |
Bottom (inherited from Control) | Gets the distance between the bottom edge of the control and the top edge of its container's client area.
Bounds (inherited from Control) | Gets or sets the size and location of the control including its nonclient elements.
CancelButton (inherited from Form) | Gets or sets the button control that is clicked when the user presses the ESC key.
CanFocus (inherited from Control) | Gets a value indicating whether the control can receive focus.
CanSelect (inherited from Control) | Gets a value indicating whether the control can be selected.
Capture (inherited from Control) | Gets or sets a value indicating whether the control has captured the mouse.
CausesValidation (inherited from Control) | Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
ClientRectangle (inherited from Control) | Gets the rectangle that represents the client area of the control.
ClientSize (inherited from Form) | Gets or sets the size of the client area of the form.
CompanyName (inherited from Control) | Gets the name of the company or creator of the application containing the control.
Container (inherited from Component) | Gets the IContainer that contains the Component.
ContainsFocus (inherited from Control) | Gets a value indicating whether the control, or one of its child controls, currently has the input focus.
ContextMenu (inherited from Control) | Gets or sets the shortcut menu associated with the control.
ControlBox (inherited from Form) | Gets or sets a value indicating whether a control box is displayed in the caption bar of the form.
Controls (inherited from Control) | Gets the collection of controls contained within the control.
Created (inherited from Control) | Gets a value indicating whether the control has been created.
Cursor (inherited from Control) | Gets or sets the cursor that is displayed when the mouse pointer is over the control.
DataBindings (inherited from Control) | Gets the data bindings for the control.
DesktopBounds (inherited from Form) | Gets or sets the size and location of the form on the Windows desktop.
DesktopLocation (inherited from Form) | Gets or sets the location of the form on the Windows desktop.
DialogResult (inherited from Form) | Gets or sets the dialog result for the form.
DisplayRectangle (inherited from ScrollableControl) |
Disposing (inherited from Control) | Gets a value indicating whether the control is in the process of being disposed of.
Dock (inherited from Control) | Gets or sets which edge of the parent container a control is docked to.
DockPadding (inherited from ScrollableControl) | Gets the dock padding settings for all edges of the control.
Enabled (inherited from Control) | Gets or sets a value indicating whether the control can respond to user interaction.
Focused (inherited from Control) | Gets a value indicating whether the control has input focus.
Font (inherited from Control) | Gets or sets the font of the text displayed by the control.
ForeColor (inherited from Control) | Gets or sets the foreground color of the control.
FormBorderStyle (inherited from Form) | Gets or sets the border style of the form.
Handle (inherited from Control) | Gets the window handle that the control is bound to.
HasChildren (inherited from Control) | Gets a value indicating whether the control contains one or more child controls.
Height (inherited from Control) | Gets or sets the height of the control.
HelpButton (inherited from Form) | Gets or sets a value indicating whether a Help button should be displayed in the caption box of the form.
Icon (inherited from Form) | Gets or sets the icon for the form.
ImeMode (inherited from Control) | Gets or sets the Input Method Editor (IME) mode of the control.
InvokeRequired (inherited from Control) | Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on.
IsAccessible (inherited from Control) | Gets or sets a value indicating whether the control is visible to accessibility applications.
IsDisposed (inherited from Control) | Gets a value indicating whether the control has been disposed of.
IsHandleCreated (inherited from Control) | Gets a value indicating whether the control has a handle associated with it.
IsMdiChild (inherited from Form) | Gets a value indicating whether the form is a multiple document interface (MDI) child form.
IsMdiContainer (inherited from Form) | Gets or sets a value indicating whether the form is a container for multiple document interface (MDI) child forms.
IsRestrictedWindow (inherited from Form) |
KeyPreview (inherited from Form) | Gets or sets a value indicating whether the form will receive key events before the event is passed to the control that has focus.
Left (inherited from Control) | Gets or sets the x-coordinate of a control's left edge in pixels.
Location (inherited from Control) | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
MaximizeBox (inherited from Form) | Gets or sets a value indicating whether the maximize button is displayed in the caption bar of the form.
MaximumSize (inherited from Form) | Gets the maximum size the form can be resized to.
MdiChildren (inherited from Form) | Gets an array of forms that represent the multiple document interface (MDI) child forms that are parented to this form.
MdiParent (inherited from Form) | Gets or sets the current multiple document interface (MDI) parent form of this form.
Menu (inherited from Form) | Gets or sets the MainMenu that is displayed in the form.
MergedMenu (inherited from Form) | Gets the merged menu for the form.
MinimizeBox (inherited from Form) | Gets or sets a value indicating whether the minimize button is displayed in the caption bar of the form.
MinimumSize (inherited from Form) | Gets or sets the minimum size the form can be resized to.
Modal (inherited from Form) | Gets a value indicating whether this form is displayed modally.
Name (inherited from Control) | Gets or sets the name of the control.
Opacity (inherited from Form) | Gets or sets the opacity level of the form.
OwnedForms (inherited from Form) | Gets an array of Form objects that represent all forms that are owned by this form.
Owner (inherited from Form) | Gets or sets the form that owns this form.
Parent (inherited from Control) | Gets or sets the parent container of the control.
ParentForm (inherited from ContainerControl) | Gets the form that the container control is assigned to.
ProductName (inherited from Control) | Gets the product name of the assembly containing the control.
ProductVersion (inherited from Control) | Gets the version of the assembly containing the control.
RecreatingHandle (inherited from Control) | Gets a value indicating whether the control is currently re-creating its handle.
Region (inherited from Control) | Gets or sets the window region associated with the control.
Right (inherited from Control) | Gets the distance between the right edge of the control and the left edge of its container.
RightToLeft (inherited from Control) | Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
ShowInTaskbar (inherited from Form) | Gets or sets a value indicating whether the form is displayed in the Windows taskbar.
Site (inherited from Control) | Gets or sets the site of the control.
Size (inherited from Form) | Gets or sets the size of the form.
SizeGripStyle (inherited from Form) | Gets or sets the style of the size grip to display in the lower-right corner of the form.
StartPosition (inherited from Form) | Gets or sets the starting position of the form at run time.
TabIndex (inherited from Form) |
TabStop (inherited from Control) | Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
Tag (inherited from Control) | Gets or sets the object that contains data about the control.
Text (inherited from Control) | Gets or sets the text associated with this control.
Top (inherited from Control) | Gets or sets the y-coordinate of the control's top edge in pixels.
TopLevel (inherited from Form) | Gets or sets a value indicating whether to display the form as a top-level window.
TopLevelControl (inherited from Control) | Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
TopMost (inherited from Form) | Gets or sets a value indicating whether the form should be displayed as the top-most form of your application.
TransparencyKey (inherited from Form) | Gets or sets the color that will represent transparent areas of the form.
Value | Gets or sets the text to edit.
Visible (inherited from Control) | Gets or sets a value indicating whether the control is displayed.
Width (inherited from Control) | Gets or sets the width of the control.
WindowState (inherited from Form) | Gets or sets the form's window state.
WindowTarget (inherited from Control) |

Protected Instance Properties

CreateParams (inherited from Form) |
DefaultImeMode (inherited from Form) | Gets the default Input Method Editor (IME) mode supported by the control.
DefaultSize (inherited from Form) |
DesignMode (inherited from Component) | Gets a value that indicates whether the Component is currently in design mode.
Events (inherited from Component) | Gets the list of event handlers that are attached to this Component.
FontHeight (inherited from Control) | Gets or sets the height of the font of the control.
HScroll (inherited from ScrollableControl) | Gets or sets a value indicating whether the horizontal scroll bar is visible.
MaximizedBounds (inherited from Form) | Gets and sets the size of the form when it is maximized.
RenderRightToLeft (inherited from Control) |
ResizeRedraw (inherited from Control) | Gets or sets a value indicating whether the control redraws itself when resized.
ShowFocusCues (inherited from Control) | Gets a value indicating whether the control should display focus rectangles.
ShowKeyboardCues (inherited from Control) | Gets a value indicating whether the control should display keyboard shortcuts.
VScroll (inherited from ScrollableControl) | Gets or sets a value indicating whether the vertical scroll bar is visible.

See Also

TextEditorForm Class | NDoc.Core Namespace


TextEditorForm.Value Property

Gets or sets the text to edit.

public string Value {get; set;}

Property Value

The text to edit.

See Also

TextEditorForm Class | NDoc.Core Namespace


TextEditorForm Methods

The methods of the TextEditorForm class are listed below. For a complete list of TextEditorForm class members, see the TextEditorForm Members topic.

Public Instance Methods

Activate (inherited from Form) | Activates the form and gives it focus.
AddOwnedForm (inherited from Form) | Adds an owned form to this form.
BeginInvoke (inherited from Control) | Overloaded. Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
BringToFront (inherited from Control) | Brings the control to the front of the z-order.
Close (inherited from Form) | Closes the form.
Contains (inherited from Control) | Retrieves a value indicating whether the specified control is a child of the control.
CreateControl (inherited from Control) | Forces the creation of the control, including the creation of the handle and any child controls.
CreateGraphics (inherited from Control) | Creates the Graphics object for the control.
CreateObjRef (inherited from MarshalByRefObject) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose (inherited from Component) | Overloaded. Releases all resources used by the Component.
DoDragDrop (inherited from Control) | Begins a drag-and-drop operation.
EndInvoke (inherited from Control) | Retrieves the return value of the asynchronous operation represented by the IAsyncResult object passed.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
FindForm (inherited from Control) | Retrieves the form that the control is on.
Focus (inherited from Control) | Sets input focus to the control.
GetChildAtPoint (inherited from Control) | Retrieves the child control that is located at the specified coordinates.
GetContainerControl (inherited from Control) | Returns the next ContainerControl up the control's chain of parent controls.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) | Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetNextControl (inherited from Control) | Retrieves the next control forward or back in the tab order of child controls.
GetType (inherited from Object) | Gets the Type of the current instance.
Hide (inherited from Control) | Conceals the control from the user.
InitializeLifetimeService (inherited from MarshalByRefObject) | Obtains a lifetime service object to control the lifetime policy for this instance.
Invalidate (inherited from Control) | Overloaded. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
Invoke (inherited from Control) | Overloaded. Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
LayoutMdi (inherited from Form) | Arranges the multiple document interface (MDI) child forms within the MDI parent form.
PerformLayout (inherited from Control) | Overloaded. Forces the control to apply layout logic to all its child controls.
PointToClient (inherited from Control) | Computes the location of the specified screen point into client coordinates.
PointToScreen (inherited from Control) | Computes the location of the specified client point into screen coordinates.
PreProcessMessage (inherited from Control) | Preprocesses input messages within the message loop before they are dispatched.
RectangleToClient (inherited from Control) | Computes the size and location of the specified screen rectangle in client coordinates.
RectangleToScreen (inherited from Control) | Computes the size and location of the specified client rectangle in screen coordinates.
Refresh (inherited from Control) | Forces the control to invalidate its client area and immediately redraw itself and any child controls.
RemoveOwnedForm (inherited from Form) | Removes an owned form from this form.
ResetBackColor (inherited from Control) | Resets the BackColor property to its default value.
ResetBindings (inherited from Control) | Resets the DataBindings property to its default value.
ResetCursor (inherited from Control) | Resets the Cursor property to its default value.
ResetFont (inherited from Control) | Resets the Fontproperty to its default value.
ResetForeColor (inherited from Control) | Resets the ForeColor property to its default value.
ResetImeMode (inherited from Control) | Resets the ImeMode property to its default value.
ResetRightToLeft (inherited from Control) | Resets the RightToLeft property to its default value.
ResetText (inherited from Control) | Resets the Text property to its default value.
ResumeLayout (inherited from Control) | Overloaded. Resumes normal layout logic.
Scale (inherited from Control) | Overloaded. Scales the control and any child controls to the specified ratio.
ScrollControlIntoView (inherited from ScrollableControl) |
Select (inherited from Control) | Overloaded. Activates the control.
SelectNextControl (inherited from Control) | Activates the next control.
SendToBack (inherited from Control) | Sends the control to the back of the z-order.
SetAutoScrollMargin (inherited from ScrollableControl) | Sets the size of the auto-scroll margins.
SetBounds (inherited from Control) | Overloaded. Sets the bounds of the control to the specified location and size.
SetDesktopBounds (inherited from Form) | Sets the bounds of the form in desktop coordinates.
SetDesktopLocation (inherited from Form) | Sets the location of the form in desktop coordinates.
Show (inherited from Control) | Displays the control to the user.
ShowDialog (inherited from Form) | Overloaded. Shows the form as a modal dialog box with no owner window.
SuspendLayout (inherited from Control) | Temporarily suspends the layout logic for the control.
ToString (inherited from Form) |
Update (inherited from Control) | Causes the control to redraw the invalidated regions within its client area.
Validate (inherited from ContainerControl) | Validates the last invalidated control and its ancestors up through, but not including, the current control.

Protected Instance Methods

AccessibilityNotifyClients (inherited from Control) | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control.
ActivateMdiChild (inherited from Form) |
AdjustFormScrollbars (inherited from Form) |
ApplyAutoScaling (inherited from Form) |
CenterToParent (inherited from Form) |
CenterToScreen (inherited from Form) |
CreateAccessibilityInstance (inherited from Control) | Creates a new accessibility object for the control.
CreateControlsInstance (inherited from Form) |
CreateHandle (inherited from Form) |
DefWndProc (inherited from Form) |
DestroyHandle (inherited from Control) | Destroys the handle associated with the control.
Dispose | Overloaded. Clean up any resources being used.
Finalize (inherited from Component) | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
GetScrollState (inherited from ScrollableControl) |
GetService (inherited from Component) | Returns an object that represents a service provided by the Component or by its Container.
GetStyle (inherited from Control) | Retrieves the value of the specified control style bit for the control.
GetTopLevel (inherited from Control) | Determines if the control is a top-level control.
InitLayout (inherited from Control) | Called after the control has been added to another container.
InvokeGotFocus (inherited from Control) | Raises the GotFocus event for the specified control.
InvokeLostFocus (inherited from Control) | Raises the LostFocus event for the specified control.
InvokeOnClick (inherited from Control) | Raises the Click event for the specified control.
InvokePaint (inherited from Control) | Raises the Paint event for the specified control.
InvokePaintBackground (inherited from Control) | Raises the PaintBackground event for the specified control.
IsInputChar (inherited from Control) | Determines if a character is an input character that the control recognizes.
IsInputKey (inherited from Control) | Determines whether the specified key is a regular input key or a special key that requires preprocessing.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
NotifyInvalidate (inherited from Control) |
OnActivated (inherited from Form) | Raises the Activated event.
OnBackColorChanged (inherited from Control) | Raises the BackColorChanged event.
OnBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event.
OnBindingContextChanged (inherited from Control) | Raises the BindingContextChangedevent.
OnCausesValidationChanged (inherited from Control) | Raises the CausesValidationChangedevent.
OnChangeUICues (inherited from Control) | Raises the ChangeUICues event.
OnClick (inherited from Control) | Raises the Click event.
OnClosed (inherited from Form) | Raises the Closed event.
OnClosing (inherited from Form) | Raises the Closing event.
OnContextMenuChanged (inherited from Control) | Raises the ContextMenuChangedevent.
OnControlAdded (inherited from Control) | Raises the ControlAdded event.
OnControlRemoved (inherited from ContainerControl) |
OnCreateControl (inherited from Form) |
OnCursorChanged (inherited from Control) | Raises the CursorChangedevent.
OnDeactivate (inherited from Form) | Raises the Deactivate event.
OnDockChanged (inherited from Control) | Raises the DockChangedevent.
OnDoubleClick (inherited from Control) | Raises the DoubleClick event.
OnDragDrop (inherited from Control) | Raises the DragDrop event.
OnDragEnter (inherited from Control) | Raises the DragEnter event.
OnDragLeave (inherited from Control) | Raises the DragLeave event.
OnDragOver (inherited from Control) | Raises the DragOver event.
OnEnabledChanged (inherited from Control) | Raises the EnabledChanged event.
OnEnter (inherited from Control) | Raises the Enter event.
OnFontChanged (inherited from Form) |
OnForeColorChanged (inherited from Control) | Raises the ForeColorChangedevent.
OnGiveFeedback (inherited from Control) | Raises the GiveFeedback event.
OnGotFocus (inherited from Control) | Raises the GotFocus event.
OnHandleCreated (inherited from Form) |
OnHandleDestroyed (inherited from Form) |
OnHelpRequested (inherited from Control) | Raises the HelpRequested event.
OnImeModeChanged (inherited from Control) | Raises the ImeModeChanged event.
OnInputLanguageChanged (inherited from Form) | Raises the InputLanguageChanged event.
OnInputLanguageChanging (inherited from Form) | Raises the InputLanguageChanging event.
OnInvalidated (inherited from Control) | Raises the Invalidated event.
OnKeyDown (inherited from Control) | Raises the KeyDown event.
OnKeyPress (inherited from Control) | Raises the KeyPress event.
OnKeyUp (inherited from Control) | Raises the KeyUp event.
OnLayout (inherited from ScrollableControl) |
OnLeave (inherited from Control) | Raises the Leave event.
OnLoad (inherited from Form) | Raises the Load event.
OnLocationChanged (inherited from Control) | Raises the LocationChanged event.
OnLostFocus (inherited from Control) | Raises the LostFocus event.
OnMaximizedBoundsChanged (inherited from Form) | Raises the MaximizedBoundsChanged event.
OnMaximumSizeChanged (inherited from Form) | Raises the MaximumSizeChanged event.
OnMdiChildActivate (inherited from Form) | Raises the MdiChildActivate event.
OnMenuComplete (inherited from Form) | Raises the MenuComplete event.
OnMenuStart (inherited from Form) | Raises the MenuStart event.
OnMinimumSizeChanged (inherited from Form) | Raises the MinimumSizeChanged event.
OnMouseDown (inherited from Control) | Raises the MouseDown event.
OnMouseEnter (inherited from Control) | Raises the MouseEnter event.
OnMouseHover (inherited from Control) | Raises the MouseHover event.
OnMouseLeave (inherited from Control) | Raises the MouseLeave event.
OnMouseMove (inherited from Control) | Raises the MouseMove event.
OnMouseUp (inherited from Control) | Raises the MouseUp event.
OnMouseWheel (inherited from ScrollableControl) |
OnMove (inherited from Control) | Raises the Move event.
OnNotifyMessage (inherited from Control) | Notifies the control of Windows messages.
OnPaint (inherited from Form) |
OnPaintBackground (inherited from Control) | Paints the background of the control.
OnParentBackColorChanged (inherited from Control) | Raises the BackColorChanged event when the BackColor property value of the control's container changes.
OnParentBackgroundImageChanged (inherited from Control) | Raises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes.
OnParentBindingContextChanged (inherited from Control) | Raises the BindingContextChanged event when the BindingContext property value of the control's container changes.
OnParentChanged (inherited from Control) | Raises the ParentChanged event.
OnParentEnabledChanged (inherited from Control) | Raises the EnabledChanged event when the Enabled property value of the control's container changes.
OnParentFontChanged (inherited from Control) | Raises the FontChanged event when the Font property value of the control's container changes.
OnParentForeColorChanged (inherited from Control) | Raises the ForeColorChanged event when the ForeColor property value of the control's container changes.
OnParentRightToLeftChanged (inherited from Control) | Raises the RightToLeftChanged event when the RightToLeft property value of the control's container changes.
OnParentVisibleChanged (inherited from Control) | Raises the VisibleChanged event when the Visible property value of the control's container changes.
OnQueryContinueDrag (inherited from Control) | Raises the QueryContinueDrag event.
OnResize (inherited from Form) |
OnRightToLeftChanged (inherited from Control) | Raises the RightToLeftChangedevent.
OnSizeChanged (inherited from Control) | Raises the SizeChanged event.
OnStyleChanged (inherited from Form) |
OnSystemColorsChanged (inherited from Control) | Raises the SystemColorsChanged event.
OnTabIndexChanged (inherited from Control) | Raises the TabIndexChanged event.
OnTabStopChanged (inherited from Control) | Raises the TabStopChanged event.
OnTextChanged (inherited from Form) |
OnValidated (inherited from Control) | Raises the Validated event.
OnValidating (inherited from Control) | Raises the Validating event.
OnVisibleChanged (inherited from Form) |
ProcessCmdKey (inherited from Form) |
ProcessDialogChar (inherited from ContainerControl) |
ProcessDialogKey (inherited from Form) |
ProcessKeyEventArgs (inherited from Control) | Processes a key message and generates the appropriate control events.
ProcessKeyPreview (inherited from Form) |
ProcessMnemonic (inherited from ContainerControl) |
ProcessTabKey (inherited from Form) |
RaiseDragEvent (inherited from Control) |
RaiseKeyEvent (inherited from Control) |
RaiseMouseEvent (inherited from Control) |
RaisePaintEvent (inherited from Control) |
RecreateHandle (inherited from Control) | Forces the re-creation of the handle for the control.
ResetMouseEventArgs (inherited from Control) |
RtlTranslateAlignment (inherited from Control) | Overloaded. Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateContent (inherited from Control) | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text.
RtlTranslateHorizontal (inherited from Control) | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text.
RtlTranslateLeftRight (inherited from Control) | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text.
ScaleCore (inherited from Form) |
Select (inherited from Form) | Overloaded.
SetBoundsCore (inherited from Form) |
SetClientSizeCore (inherited from Form) |
SetDisplayRectLocation (inherited from ScrollableControl) |
SetScrollState (inherited from ScrollableControl) |
SetStyle (inherited from Control) | Sets the specified style bit to the specified value.
SetTopLevel (inherited from Control) | Sets the control as the top-level control.
SetVisibleCore (inherited from Form) |
UpdateBounds (inherited from Control) | Overloaded. Updates the bounds of the control with the current size and location.
UpdateDefaultButton (inherited from Form) |
UpdateStyles (inherited from Control) | Forces the assigned styles to be reapplied to the control.
UpdateZOrder (inherited from Control) | Updates the control in its parent's z-order.
WndProc (inherited from Form) |

Protected Internal Instance Methods

ProcessKeyMessage (inherited from Control) Processes a keyboard message.

Explicit Interface Implementations

IContainerControl.ActivateControl (inherited from ContainerControl)

See Also

TextEditorForm Class | NDoc.Core Namespace


Dispose Method

NDoc Documentation

TextEditorForm.Dispose Method

Clean up any resources being used.

Overload List

Inherited from Component.

public void Dispose();

Clean up any resources being used.

protected override void Dispose(bool);

See Also

TextEditorForm Class | NDoc.Core Namespace


TextEditorForm.Dispose Method (Boolean)

Clean up any resources being used.

protected override void Dispose(
bool disposing
);

See Also

TextEditorForm Class | NDoc.Core Namespace | TextEditorForm.Dispose Overload List


XmlDocumentationCache Class

Caches XML Documentation files and summaries.

For a list of all members of this type, see XmlDocumentationCache Members.

System.Object
XmlDocumentationCache

public class XmlDocumentationCache

Requirements

Namespace: NDoc.Core

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

XmlDocumentationCache Members | NDoc.Core Namespace


XmlDocumentationCache Members

XmlDocumentationCache overview

Public Instance Constructors

XmlDocumentationCache Constructor Initializes a new instance of the XmlDocumentationCache class.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetSummary | Returns the original summary for a member inherited from a specified type.
GetType (inherited from Object) | Gets the Type of the current instance.
GetXmlFor | Gets the xml documentation for the assembly of the specified type.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

XmlDocumentationCache Class | NDoc.Core Namespace


XmlDocumentationCache Constructor

Initializes a new instance of the XmlDocumentationCache class.

public XmlDocumentationCache();

See Also

XmlDocumentationCache Class | NDoc.Core Namespace


XmlDocumentationCache Methods

The methods of the XmlDocumentationCache class are listed below. For a complete list of XmlDocumentationCache class members, see the XmlDocumentationCache Members topic.

Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetSummary | Returns the original summary for a member inherited from a specified type.
GetType (inherited from Object) | Gets the Type of the current instance.
GetXmlFor | Gets the xml documentation for the assembly of the specified type.
ToString (inherited from Object) | Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

See Also

XmlDocumentationCache Class | NDoc.Core Namespace


XmlDocumentationCache.GetSummary Method

Returns the original summary for a member inherited from a specified type.

public XmlNode GetSummary(
string memberID,
Type declaringType
);

Parameters

memberID
The member ID to lookup.
declaringType
The type that declares that member.

Return Value

The summary xml node. If not found, returns an empty node.

See Also

XmlDocumentationCache Class | NDoc.Core Namespace


XmlDocumentationCache.GetXmlFor Method

Gets the xml documentation for the assembly of the specified type.

public XmlDocument GetXmlFor(
Type type
);

Return Value

The xml document. If the xml file was not found, returns an empty document.

See Also

XmlDocumentationCache Class | NDoc.Core Namespace