Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFPromptForCredential Class

  • Last UpdatedNov 18, 2025
  • 37 minute read
AFPromptForCredential Class
This dialog is used for prompting for a user credential.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          System.Windows.FormsContainerControl
            System.Windows.FormsForm
              OSIsoft.AF.UIAFPromptForCredential

Namespace:  OSIsoft.AF.UI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public class AFPromptForCredential : Form
Public Class AFPromptForCredential
	Inherits Form

Dim instance As AFPromptForCredential
public ref class AFPromptForCredential : public Form
type AFPromptForCredential =  
    class
        inherit Form
    end

The AFPromptForCredential type exposes the following members.

Constructors

  NameDescription
Public method
AFPromptForCredential
Creates a new instance of the dialog used to prompt for a user name and password.

Properties

  NameDescription
Public property
AcceptButton
Gets or sets the button on the form that is clicked when the user presses the ENTER key.
(Inherited from Form.)
Public property
AccessibilityObject
Gets the AccessibleObject assigned to the control.
(Inherited from Control.)
Public property
AccessibleDefaultActionDescription
Gets or sets the default action description of the control for use by accessibility client applications.
(Inherited from Control.)
Public property
AccessibleDescription
Gets or sets the description of the control used by accessibility client applications.
(Inherited from Control.)
Public property
AccessibleName
Gets or sets the name of the control used by accessibility client applications.
(Inherited from Control.)
Public property
AccessibleRole
Gets or sets the accessible role of the control
(Inherited from Control.)
Public property
ActiveControl
Gets or sets the active control on the container control.
(Inherited from ContainerControl.)
Public property
ActiveMdiChild
Gets the currently active multiple-document interface (MDI) child window.
(Inherited from Form.)
Public property
AllowDrop
Gets or sets a value indicating whether the control can accept data that the user drags onto it.
(Inherited from Control.)
Public property
AllowTransparency
Gets or sets a value indicating whether the opacity of the form can be adjusted.
(Inherited from Form.)
Public property
Anchor
Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.
(Inherited from Control.)
Public property
AuthenticationMode
The selected authentication mode in the dialog.
Public property
AutoScale Obsolete.
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.
(Inherited from Form.)
Public property
AutoScaleBaseSize
Gets or sets the base size used for autoscaling of the form.
(Inherited from Form.)
Public property
AutoScaleDimensions
Gets or sets the dimensions that the control was designed to.
(Inherited from ContainerControl.)
Public property
AutoScaleMode
Gets or sets the automatic scaling mode of the control.
(Inherited from ContainerControl.)
Public property
AutoScroll
Gets or sets a value indicating whether the form enables autoscrolling.
(Inherited from Form.)
Public property
AutoScrollMargin
Gets or sets the size of the auto-scroll margin.
(Inherited from ScrollableControl.)
Public property
AutoScrollMinSize
Gets or sets the minimum size of the auto-scroll.
(Inherited from ScrollableControl.)
Public property
AutoScrollOffset
Gets or sets where this control is scrolled to in ScrollControlIntoView(Control).
(Inherited from Control.)
Public property
AutoScrollPosition
Gets or sets the location of the auto-scroll position.
(Inherited from ScrollableControl.)
Public property
AutoSize
Resize the form according to the setting of AutoSizeMode.
(Inherited from Form.)
Public property
AutoSizeMode
Gets or sets the mode by which the form automatically resizes itself.
(Inherited from Form.)
Public property
AutoValidate
Gets or sets a value that indicates whether controls in this container will be automatically validated when the focus changes.
(Inherited from Form.)
Public property
BackColor
Gets or sets the background color for the control.
(Inherited from Form.)
Public property
BackgroundImage
Gets or sets the background image displayed in the control.
(Inherited from Control.)
Public property
BackgroundImageLayout
Gets or sets the background image layout as defined in the ImageLayout enumeration.
(Inherited from Control.)
Public property
BindingContext
Gets or sets the BindingContext for the control.
(Inherited from ContainerControl.)
Public property
Bottom
Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
(Inherited from Control.)
Public property
Bounds
Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
(Inherited from Control.)
Public property
CancelButton
Gets or sets the button control that is clicked when the user presses the ESC key.
(Inherited from Form.)
Public property
CanFocus
Gets a value indicating whether the control can receive focus.
(Inherited from Control.)
Public property
CanSelect
Gets a value indicating whether the control can be selected.
(Inherited from Control.)
Public property
Capture
Gets or sets a value indicating whether the control has captured the mouse.
(Inherited from Control.)
Public property
CausesValidation
Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
(Inherited from Control.)
Public property
ClientRectangle
Gets the rectangle that represents the client area of the control.
(Inherited from Control.)
Public property
ClientSize
Gets or sets the size of the client area of the form.
(Inherited from Form.)
Public property
CompanyName
Gets the name of the company or creator of the application containing the control.
(Inherited from Control.)
Public property
Container
Gets the IContainer that contains the Component.
(Inherited from Component.)
Public property
ContainsFocus
Gets a value indicating whether the control, or one of its child controls, currently has the input focus.
(Inherited from Control.)
Public property
ContextMenu
Gets or sets the shortcut menu associated with the control.
(Inherited from Control.)
Public property
ContextMenuStrip
Gets or sets the ContextMenuStrip associated with this control.
(Inherited from Control.)
Public property
ControlBox
Gets or sets a value indicating whether a control box is displayed in the caption bar of the form.
(Inherited from Form.)
Public property
Controls
Gets the collection of controls contained within the control.
(Inherited from Control.)
Public property
Created
Gets a value indicating whether the control has been created.
(Inherited from Control.)
Public property
CurrentAutoScaleDimensions
Gets the current run-time dimensions of the screen.
(Inherited from ContainerControl.)
Public property
Cursor
Gets or sets the cursor that is displayed when the mouse pointer is over the control.
(Inherited from Control.)
Public property
DataBindings
Gets the data bindings for the control.
(Inherited from Control.)
Public property
DesktopBounds
Gets or sets the size and location of the form on the Windows desktop.
(Inherited from Form.)
Public property
DesktopLocation
Gets or sets the location of the form on the Windows desktop.
(Inherited from Form.)
Public property
DialogResult
Gets or sets the dialog result for the form.
(Inherited from Form.)
Public property
DisplayRectangle
Gets the rectangle that represents the virtual display area of the control.
(Inherited from ScrollableControl.)
Public property
Disposing
Gets a value indicating whether the base Control class is in the process of disposing.
(Inherited from Control.)
Public property
Dock
Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
(Inherited from Control.)
Public property
DockPadding
Gets the dock padding settings for all edges of the control.
(Inherited from ScrollableControl.)
Public property
Enabled
Gets or sets a value indicating whether the control can respond to user interaction.
(Inherited from Control.)
Public property
Focused
Gets a value indicating whether the control has input focus.
(Inherited from Control.)
Public property
Font
Gets or sets the font of the text displayed by the control.
(Inherited from Control.)
Public property
ForeColor
Gets or sets the foreground color of the control.
(Inherited from Control.)
Public property
FormBorderStyle
Gets or sets the border style of the form.
(Inherited from Form.)
Public property
Handle
Gets the window handle that the control is bound to.
(Inherited from Control.)
Public property
HasChildren
Gets a value indicating whether the control contains one or more child controls.
(Inherited from Control.)
Public property
Height
Gets or sets the height of the control.
(Inherited from Control.)
Public property
HelpButton
Gets or sets a value indicating whether a Help button should be displayed in the caption box of the form.
(Inherited from Form.)
Public property
HorizontalScroll
Gets the characteristics associated with the horizontal scroll bar.
(Inherited from ScrollableControl.)
Public property
Icon
Gets or sets the icon for the form.
(Inherited from Form.)
Public property
ImeMode
Gets or sets the Input Method Editor (IME) mode of the control.
(Inherited from Control.)
Public property
InvokeRequired
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.
(Inherited from Control.)
Public property
IsAccessible
Gets or sets a value indicating whether the control is visible to accessibility applications.
(Inherited from Control.)
Public property
IsDisposed
Gets a value indicating whether the control has been disposed of.
(Inherited from Control.)
Public property
IsHandleCreated
Gets a value indicating whether the control has a handle associated with it.
(Inherited from Control.)
Public property
IsMdiChild
Gets a value indicating whether the form is a multiple-document interface (MDI) child form.
(Inherited from Form.)
Public property
IsMdiContainer
Gets or sets a value indicating whether the form is a container for multiple-document interface (MDI) child forms.
(Inherited from Form.)
Public property
IsMirrored
Gets a value indicating whether the control is mirrored.
(Inherited from Control.)
Public property
IsRestrictedWindow
Gets a value indicating whether the form can use all windows and user input events without restriction.
(Inherited from Form.)
Public property
KeyPreview
Gets or sets a value indicating whether the form will receive key events before the event is passed to the control that has focus.
(Inherited from Form.)
Public property
LayoutEngine
Gets a cached instance of the control's layout engine.
(Inherited from Control.)
Public property
Left
Gets or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
(Inherited from Control.)
Public property
Location
Gets or sets the Point that represents the upper-left corner of the Form in screen coordinates.
(Inherited from Form.)
Public property
MainMenuStrip
Gets or sets the primary menu container for the form.
(Inherited from Form.)
Public property
Margin
Gets or sets the space between controls.
(Inherited from Form.)
Public property
MaximizeBox
Gets or sets a value indicating whether the Maximize button is displayed in the caption bar of the form.
(Inherited from Form.)
Public property
MaximumSize
Gets the maximum size the form can be resized to.
(Inherited from Form.)
Public property
MdiChildren
Gets an array of forms that represent the multiple-document interface (MDI) child forms that are parented to this form.
(Inherited from Form.)
Public property
MdiParent
Gets or sets the current multiple-document interface (MDI) parent form of this form.
(Inherited from Form.)
Public property
Menu
Gets or sets the MainMenu that is displayed in the form.
(Inherited from Form.)
Public property
MergedMenu
Gets the merged menu for the form.
(Inherited from Form.)
Public property
MinimizeBox
Gets or sets a value indicating whether the Minimize button is displayed in the caption bar of the form.
(Inherited from Form.)
Public property
MinimumSize
Gets or sets the minimum size the form can be resized to.
(Inherited from Form.)
Public property
Modal
Gets a value indicating whether this form is displayed modally.
(Inherited from Form.)
Public property
Name
Gets or sets the name of the control.
(Inherited from Control.)
Public property
Opacity
Gets or sets the opacity level of the form.
(Inherited from Form.)
Public property
OwnedForms
Gets an array of Form objects that represent all forms that are owned by this form.
(Inherited from Form.)
Public property
Owner
Gets or sets the form that owns this form.
(Inherited from Form.)
Public property
Padding
Gets or sets padding within the control.
(Inherited from Control.)
Public property
Parent
Gets or sets the parent container of the control.
(Inherited from Control.)
Public property
ParentForm
Gets the form that the container control is assigned to.
(Inherited from ContainerControl.)
Public property
Password
The value of the password in the dialog.
Public property
PreferredSize
Gets the size of a rectangular area into which the control can fit.
(Inherited from Control.)
Public property
ProductName
Gets the product name of the assembly containing the control.
(Inherited from Control.)
Public property
ProductVersion
Gets the version of the assembly containing the control.
(Inherited from Control.)
Public property
RecreatingHandle
Gets a value indicating whether the control is currently re-creating its handle.
(Inherited from Control.)
Public property
Region
Gets or sets the window region associated with the control.
(Inherited from Control.)
Public property
RememberCredential
Indicates whether the remember credential check box is checked.
Public property
RestoreBounds
Gets the location and size of the form in its normal window state.
(Inherited from Form.)
Public property
Right
Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
(Inherited from Control.)
Public property
RightToLeft
Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
(Inherited from Control.)
Public property
RightToLeftLayout
Gets or sets a value indicating whether right-to-left mirror placement is turned on.
(Inherited from Form.)
Public property
ShowIcon
Gets or sets a value indicating whether an icon is displayed in the caption bar of the form.
(Inherited from Form.)
Public property
ShowInTaskbar
Gets or sets a value indicating whether the form is displayed in the Windows taskbar.
(Inherited from Form.)
Public property
Site
Gets or sets the site of the control.
(Inherited from Control.)
Public property
Size
Gets or sets the size of the form.
(Inherited from Form.)
Public property
SizeGripStyle
Gets or sets the style of the size grip to display in the lower-right corner of the form.
(Inherited from Form.)
Public property
StartPosition
Gets or sets the starting position of the form at run time.
(Inherited from Form.)
Public property
TabIndex
Gets or sets the tab order of the control within its container.
(Inherited from Form.)
Public property
TabStop
Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
(Inherited from Form.)
Public property
Tag
Gets or sets the object that contains data about the control.
(Inherited from Control.)
Public property
Text
Gets or sets the text associated with this control.
(Inherited from Form.)
Public property
Top
Gets or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
(Inherited from Control.)
Public property
TopLevel
Gets or sets a value indicating whether to display the form as a top-level window.
(Inherited from Form.)
Public property
TopLevelControl
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.
(Inherited from Control.)
Public property
TopMost
Gets or sets a value indicating whether the form should be displayed as a topmost form.
(Inherited from Form.)
Public property
TransparencyKey
Gets or sets the color that will represent transparent areas of the form.
(Inherited from Form.)
Public property
UserName
The value of the user name in the dialog.
Public property
UseWaitCursor
Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls.
(Inherited from Control.)
Public property
VerticalScroll
Gets the characteristics associated with the vertical scroll bar.
(Inherited from ScrollableControl.)
Public property
Visible
Gets or sets a value indicating whether the control and all its child controls are displayed.
(Inherited from Control.)
Public property
Width
Gets or sets the width of the control.
(Inherited from Control.)
Public property
WindowState
Gets or sets a value that indicates whether form is minimized, maximized, or normal.
(Inherited from Form.)
Public property
WindowTarget
This property is not relevant for this class.
(Inherited from Control.)

Methods

  NameDescription
Public method
Activate
Activates the form and gives it focus.
(Inherited from Form.)
Public method
AddOwnedForm
Adds an owned form to this form.
(Inherited from Form.)
Public method
BeginInvoke(Delegate)
Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
(Inherited from Control.)
Public method
BeginInvoke(Delegate, Object)
Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
(Inherited from Control.)
Public method
BringToFront
Brings the control to the front of the z-order.
(Inherited from Control.)
Public method
Close
Closes the form.
(Inherited from Form.)
Public method
Contains
Retrieves a value indicating whether the specified control is a child of the control.
(Inherited from Control.)
Public method
CreateControl
Forces the creation of the visible control, including the creation of the handle and any visible child controls.
(Inherited from Control.)
Public method
CreateGraphics
Creates the Graphics for the control.
(Inherited from Control.)
Public method
CreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public method
Dispose
Releases all resources used by the Component.
(Inherited from Component.)
Public method
DoDragDrop
Begins a drag-and-drop operation.
(Inherited from Control.)
Public method
DrawToBitmap
Supports rendering to the specified bitmap.
(Inherited from Control.)
Public method
EndInvoke
Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed.
(Inherited from Control.)
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
FindForm
Retrieves the form that the control is on.
(Inherited from Control.)
Public method
Focus
Sets input focus to the control.
(Inherited from Control.)
Public method
GetChildAtPoint(Point)
Retrieves the child control that is located at the specified coordinates.
(Inherited from Control.)
Public method
GetChildAtPoint(Point, GetChildAtPointSkip)
Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.
(Inherited from Control.)
Public method
GetContainerControl
Returns the next ContainerControl up the control's chain of parent controls.
(Inherited from Control.)
Public method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method
GetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public method
GetNextControl
Retrieves the next control forward or back in the tab order of child controls.
(Inherited from Control.)
Public method
GetPreferredSize
Retrieves the size of a rectangular area into which a control can be fitted.
(Inherited from Control.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
Hide
Conceals the control from the user.
(Inherited from Control.)
Public method
InitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public method
Invalidate
Invalidates the entire surface of the control and causes the control to be redrawn.
(Inherited from Control.)
Public method
Invalidate(Region)
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.
(Inherited from Control.)
Public method
Invalidate(Boolean)
Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control.)
Public method
Invalidate(Rectangle)
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.
(Inherited from Control.)
Public method
Invalidate(Region, Boolean)
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. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control.)
Public method
Invalidate(Rectangle, Boolean)
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. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control.)
Public method
Invoke(Delegate)
Executes the specified delegate on the thread that owns the control's underlying window handle.
(Inherited from Control.)
Public method
Invoke(Delegate, Object)
Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
(Inherited from Control.)
Public method
LayoutMdi
Arranges the multiple-document interface (MDI) child forms within the MDI parent form.
(Inherited from Form.)
Public method
PerformAutoScale
Performs scaling of the container control and its children.
(Inherited from ContainerControl.)
Public method
PerformLayout
Forces the control to apply layout logic to all its child controls.
(Inherited from Control.)
Public method
PerformLayout(Control, String)
Forces the control to apply layout logic to all its child controls.
(Inherited from Control.)
Public method
PointToClient
Computes the location of the specified screen point into client coordinates.
(Inherited from Control.)
Public method
PointToScreen
Computes the location of the specified client point into screen coordinates.
(Inherited from Control.)
Public method
PreProcessControlMessage
Preprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control.)
Public method
PreProcessMessage
Preprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control.)
Public method
RectangleToClient
Computes the size and location of the specified screen rectangle in client coordinates.
(Inherited from Control.)
Public method
RectangleToScreen
Computes the size and location of the specified client rectangle in screen coordinates.
(Inherited from Control.)
Public method
Refresh
Forces the control to invalidate its client area and immediately redraw itself and any child controls.
(Inherited from Control.)
Public method
RemoveOwnedForm
Removes an owned form from this form.
(Inherited from Form.)
Public method
ResetBackColor
Resets the BackColor property to its default value.
(Inherited from Control.)
Public method
ResetBindings
Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values.
(Inherited from Control.)
Public method
ResetCursor
Resets the Cursor property to its default value.
(Inherited from Control.)
Public method
ResetFont
Resets the Font property to its default value.
(Inherited from Control.)
Public method
ResetForeColor
Resets the ForeColor property to its default value.
(Inherited from Control.)
Public method
ResetImeMode
Resets the ImeMode property to its default value.
(Inherited from Control.)
Public method
ResetRightToLeft
Resets the RightToLeft property to its default value.
(Inherited from Control.)
Public method
ResetText
Resets the Text property to its default value.
(Inherited from Control.)
Public method
ResumeLayout
Resumes usual layout logic.
(Inherited from Control.)
Public method
ResumeLayout(Boolean)
Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
(Inherited from Control.)
Public methodStatic member
SaveCredential
Save a credential into the Windows Credential Manager.
Public method
Scale(Single) Obsolete.
Scales the control and any child controls.
(Inherited from Control.)
Public method
Scale(SizeF)
Scales the control and all child controls by the specified scaling factor.
(Inherited from Control.)
Public method
Scale(Single, Single) Obsolete.
Scales the entire control and any child controls.
(Inherited from Control.)
Public method
ScrollControlIntoView
Scrolls the specified child control into view on an auto-scroll enabled control.
(Inherited from ScrollableControl.)
Public method
Select
Activates the control.
(Inherited from Control.)
Public method
SelectNextControl
Activates the next control.
(Inherited from Control.)
Public method
SendToBack
Sends the control to the back of the z-order.
(Inherited from Control.)
Public method
SetAutoScrollMargin
Sets the size of the auto-scroll margins.
(Inherited from ScrollableControl.)
Public method
SetBounds(Int32, Int32, Int32, Int32)
Sets the bounds of the control to the specified location and size.
(Inherited from Control.)
Public method
SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)
Sets the specified bounds of the control to the specified location and size.
(Inherited from Control.)
Public method
SetDesktopBounds
Sets the bounds of the form in desktop coordinates.
(Inherited from Form.)
Public method
SetDesktopLocation
Sets the location of the form in desktop coordinates.
(Inherited from Form.)
Public method
Show
Displays the control to the user.
(Inherited from Control.)
Public method
Show(IWin32Window)
Shows the form with the specified owner to the user.
(Inherited from Form.)
Public method
ShowDialog
Shows the form as a modal dialog box.
(Inherited from Form.)
Public method
ShowDialog(IWin32Window)
Shows the form as a modal dialog box with the specified owner.
(Inherited from Form.)
Public methodStatic member
ShowDialog(IWin32Window, PISystem, Boolean)
Show the prompt for credential dialog to get a NetworkCredential to connect to a PISystem.
Public methodStatic member
ShowDialog(IWin32Window, PICollectiveMember, PIAuthenticationMode, Boolean, Boolean, Boolean)
Show the prompt for credential dialog to get a NetworkCredential to connect to a PIServer.
Public methodStatic member
ShowDialog(IWin32Window, PIServer, PIAuthenticationMode, Boolean, Boolean, Boolean)
Show the prompt for credential dialog to get a NetworkCredential to connect to a PIServer.
Public method
SuspendLayout
Temporarily suspends the layout logic for the control.
(Inherited from Control.)
Public method
ToString
Gets a string representing the current instance of the form.
(Inherited from Form.)
Public method
Update
Causes the control to redraw the invalidated regions within its client area.
(Inherited from Control.)
Public method
Validate
Verifies the value of the control losing focus by causing the Validating and Validated events to occur, in that order.
(Inherited from ContainerControl.)
Public method
Validate(Boolean)
Verifies the value of the control that is losing focus; conditionally dependent on whether automatic validation is turned on.
(Inherited from ContainerControl.)
Public method
ValidateChildren
Causes all of the child controls within a control that support validation to validate their data.
(Inherited from Form.)
Public method
ValidateChildren(ValidationConstraints)
Causes all of the child controls within a control that support validation to validate their data.
(Inherited from Form.)

Events

  NameDescription
Public event
Activated
Occurs when the form is activated in code or by the user.
(Inherited from Form.)
Public event
AutoSizeChanged
Occurs when the AutoSize property changes.
(Inherited from Form.)
Public event
AutoValidateChanged
Occurs when the AutoValidate property changes.
(Inherited from Form.)
Public event
BackColorChanged
Occurs when the value of the BackColor property changes.
(Inherited from Control.)
Public event
BackgroundImageChanged
Occurs when the value of the BackgroundImage property changes.
(Inherited from Control.)
Public event
BackgroundImageLayoutChanged
Occurs when the BackgroundImageLayout property changes.
(Inherited from Control.)
Public event
BindingContextChanged
Occurs when the value of the BindingContext property changes.
(Inherited from Control.)
Public event
CausesValidationChanged
Occurs when the value of the CausesValidation property changes.
(Inherited from Control.)
Public event
ChangeUICues
Occurs when the focus or keyboard user interface (UI) cues change.
(Inherited from Control.)
Public event
Click
Occurs when the control is clicked.
(Inherited from Control.)
Public event
ClientSizeChanged
Occurs when the value of the ClientSize property changes.
(Inherited from Control.)
Public event
Closed
Occurs when the form is closed.
(Inherited from Form.)
Public event
Closing
Occurs when the form is closing.
(Inherited from Form.)
Public event
ContextMenuChanged
Occurs when the value of the ContextMenu property changes.
(Inherited from Control.)
Public event
ContextMenuStripChanged
Occurs when the value of the ContextMenuStrip property changes.
(Inherited from Control.)
Public event
ControlAdded
Occurs when a new control is added to the ControlControlCollection.
(Inherited from Control.)
Public event
ControlRemoved
Occurs when a control is removed from the ControlControlCollection.
(Inherited from Control.)
Public event
CursorChanged
Occurs when the value of the Cursor property changes.
(Inherited from Control.)
Public event
Deactivate
Occurs when the form loses focus and is no longer the active form.
(Inherited from Form.)
Public event
Disposed
Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component.)
Public event
DockChanged
Occurs when the value of the Dock property changes.
(Inherited from Control.)
Public event
DoubleClick
Occurs when the control is double-clicked.
(Inherited from Control.)
Public event
DragDrop
Occurs when a drag-and-drop operation is completed.
(Inherited from Control.)
Public event
DragEnter
Occurs when an object is dragged into the control's bounds.
(Inherited from Control.)
Public event
DragLeave
Occurs when an object is dragged out of the control's bounds.
(Inherited from Control.)
Public event
DragOver
Occurs when an object is dragged over the control's bounds.
(Inherited from Control.)
Public event
EnabledChanged
Occurs when the Enabled property value has changed.
(Inherited from Control.)
Public event
Enter
Occurs when the control is entered.
(Inherited from Control.)
Public event
FontChanged
Occurs when the Font property value changes.
(Inherited from Control.)
Public event
ForeColorChanged
Occurs when the ForeColor property value changes.
(Inherited from Control.)
Public event
FormClosed
Occurs after the form is closed.
(Inherited from Form.)
Public event
FormClosing
Occurs before the form is closed.
(Inherited from Form.)
Public event
GiveFeedback
Occurs during a drag operation.
(Inherited from Control.)
Public event
GotFocus
Occurs when the control receives focus.
(Inherited from Control.)
Public event
HandleCreated
Occurs when a handle is created for the control.
(Inherited from Control.)
Public event
HandleDestroyed
Occurs when the control's handle is in the process of being destroyed.
(Inherited from Control.)
Public event
HelpButtonClicked
Occurs when the Help button is clicked.
(Inherited from Form.)
Public event
HelpRequested
Occurs when the user requests help for a control.
(Inherited from Control.)
Public event
ImeModeChanged
Occurs when the ImeMode property has changed.
(Inherited from Control.)
Public event
InputLanguageChanged
Occurs after the input language of the form has changed.
(Inherited from Form.)
Public event
InputLanguageChanging
Occurs when the user attempts to change the input language for the form.
(Inherited from Form.)
Public event
Invalidated
Occurs when a control's display requires redrawing.
(Inherited from Control.)
Public event
KeyDown
Occurs when a key is pressed while the control has focus.
(Inherited from Control.)
Public event
KeyPress
Occurs when a character. space or backspace key is pressed while the control has focus.
(Inherited from Control.)
Public event
KeyUp
Occurs when a key is released while the control has focus.
(Inherited from Control.)
Public event
Layout
Occurs when a control should reposition its child controls.
(Inherited from Control.)
Public event
Leave
Occurs when the input focus leaves the control.
(Inherited from Control.)
Public event
Load
Occurs before a form is displayed for the first time.
(Inherited from Form.)
Public event
LocationChanged
Occurs when the Location property value has changed.
(Inherited from Control.)
Public event
LostFocus
Occurs when the control loses focus.
(Inherited from Control.)
Public event
MarginChanged
Occurs when the Margin property changes.
(Inherited from Form.)
Public event
MaximizedBoundsChanged
Occurs when the value of the MaximizedBounds property has changed.
(Inherited from Form.)
Public event
MaximumSizeChanged
Occurs when the value of the MaximumSize property has changed.
(Inherited from Form.)
Public event
MdiChildActivate
Occurs when a multiple-document interface (MDI) child form is activated or closed within an MDI application.
(Inherited from Form.)
Public event
MenuComplete
Occurs when the menu of a form loses focus.
(Inherited from Form.)
Public event
MenuStart
Occurs when the menu of a form receives focus.
(Inherited from Form.)
Public event
MinimumSizeChanged
Occurs when the value of the MinimumSize property has changed.
(Inherited from Form.)
Public event
MouseCaptureChanged
Occurs when the control loses mouse capture.
(Inherited from Control.)
Public event
MouseClick
Occurs when the control is clicked by the mouse.
(Inherited from Control.)
Public event
MouseDoubleClick
Occurs when the control is double clicked by the mouse.
(Inherited from Control.)
Public event
MouseDown
Occurs when the mouse pointer is over the control and a mouse button is pressed.
(Inherited from Control.)
Public event
MouseEnter
Occurs when the mouse pointer enters the control.
(Inherited from Control.)
Public event
MouseHover
Occurs when the mouse pointer rests on the control.
(Inherited from Control.)
Public event
MouseLeave
Occurs when the mouse pointer leaves the control.
(Inherited from Control.)
Public event
MouseMove
Occurs when the mouse pointer is moved over the control.
(Inherited from Control.)
Public event
MouseUp
Occurs when the mouse pointer is over the control and a mouse button is released.
(Inherited from Control.)
Public event
MouseWheel
Occurs when the mouse wheel moves while the control has focus.
(Inherited from Control.)
Public event
Move
Occurs when the control is moved.
(Inherited from Control.)
Public event
PaddingChanged
Occurs when the control's padding changes.
(Inherited from Control.)
Public event
Paint
Occurs when the control is redrawn.
(Inherited from Control.)
Public event
ParentChanged
Occurs when the Parent property value changes.
(Inherited from Control.)
Public event
PreviewKeyDown
Occurs before the KeyDown event when a key is pressed while focus is on this control.
(Inherited from Control.)
Public event
QueryAccessibilityHelp
Occurs when AccessibleObject is providing help to accessibility applications.
(Inherited from Control.)
Public event
QueryContinueDrag
Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.
(Inherited from Control.)
Public event
RegionChanged
Occurs when the value of the Region property changes.
(Inherited from Control.)
Public event
Resize
Occurs when the control is resized.
(Inherited from Control.)
Public event
ResizeBegin
Occurs when a form enters resizing mode.
(Inherited from Form.)
Public event
ResizeEnd
Occurs when a form exits resizing mode.
(Inherited from Form.)
Public event
RightToLeftChanged
Occurs when the RightToLeft property value changes.
(Inherited from Control.)
Public event
RightToLeftLayoutChanged
Occurs after the value of the RightToLeftLayout property changes.
(Inherited from Form.)
Public event
Scroll
Occurs when the user or code scrolls through the client area.
(Inherited from ScrollableControl.)
Public event
Shown
Occurs whenever the form is first displayed.
(Inherited from Form.)
Public event
SizeChanged
Occurs when the Size property value changes.
(Inherited from Control.)
Public event
StyleChanged
Occurs when the control style changes.
(Inherited from Control.)
Public event
SystemColorsChanged
Occurs when the system colors change.
(Inherited from Control.)
Public event
TabIndexChanged
Occurs when the value of the TabIndex property changes.
(Inherited from Form.)
Public event
TabStopChanged
Occurs when the TabStop property changes.
(Inherited from Form.)
Public event
TextChanged
Occurs when the Text property value changes.
(Inherited from Control.)
Public event
Validated
Occurs when the control is finished validating.
(Inherited from Control.)
Public event
Validating
Occurs when the control is validating.
(Inherited from Control.)
Public event
VisibleChanged
Occurs when the Visible property value changes.
(Inherited from Control.)

Remarks

The PISystem and PIServer methods and that specify an allowPrompt parameter use this dialog when prompting for user credentials. This dialog can also be called by client applications directly to prompt for a user name and password. A client application can also use one of the static ShowDialog Overload methods.

Note Notes to Callers
If not using one of the static ShowDialog Overload methods then you should call SaveCredential(String, String, SecureString) keying off the RememberCredential property as appropriate.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7

See Also

TitleResults for “How to create a CRG?”Also Available in