Code:
/ Net / Net / 3.5.50727.3053 / DEVDIV / depot / DevDiv / releases / whidbey / netfxsp / ndp / fx / src / WinForms / Managed / System / WinForms / UserControl.cs / 1 / UserControl.cs
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
/*
*/
namespace System.Windows.Forms {
using Microsoft.Win32;
using System;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.ComponentModel.Design.Serialization;
using System.Diagnostics;
using System.Drawing;
using System.Runtime.InteropServices;
using System.Runtime.Remoting;
using System.Security.Permissions;
using System.Windows.Forms.Design;
using System.Windows.Forms.Layout;
///
/// Represents an empty control that can be used in the Forms Designer to create other controls. By extending form, UserControl inherits all of
/// the standard positioning and mnemonic handling code that is necessary
/// in a user control.
///
[
ComVisible(true),
ClassInterface(ClassInterfaceType.AutoDispatch),
Designer("System.Windows.Forms.Design.UserControlDocumentDesigner, " + AssemblyRef.SystemDesign, typeof(IRootDesigner)),
Designer("System.Windows.Forms.Design.ControlDesigner, " + AssemblyRef.SystemDesign),
DesignerCategory("UserControl"),
DefaultEvent("Load")
]
public class UserControl : ContainerControl {
private static readonly object EVENT_LOAD = new object();
private BorderStyle borderStyle = System.Windows.Forms.BorderStyle.None;
///
/// Creates a new UserControl object. A vast majority of people
/// will not want to instantiate this class directly, but will be a
/// sub-class of it.
///
public UserControl() {
SetScrollState(ScrollStateAutoScrolling, false);
SetState(STATE_VISIBLE, true);
SetState(STATE_TOPLEVEL, false);
SetStyle(ControlStyles.SupportsTransparentBackColor, true);
}
///
/// Override to re-expose AutoSize.
///
[Browsable(true), EditorBrowsable(EditorBrowsableState.Always),
DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
public override bool AutoSize
{
get
{
return base.AutoSize;
}
set
{
base.AutoSize = value;
}
}
///
/// Re-expose AutoSizeChanged.
///
[Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
public new event EventHandler AutoSizeChanged {
add {
base.AutoSizeChanged += value;
}
remove {
base.AutoSizeChanged -= value;
}
}
///
/// Allows the control to optionally shrink when AutoSize is true.
///
[
SRDescription(SR.ControlAutoSizeModeDescr),
SRCategory(SR.CatLayout),
Browsable(true),
DefaultValue(AutoSizeMode.GrowOnly),
Localizable(true)
]
public AutoSizeMode AutoSizeMode {
get {
return GetAutoSizeMode();
}
set {
if (!ClientUtils.IsEnumValid(value, (int)value, (int)AutoSizeMode.GrowAndShrink, (int)AutoSizeMode.GrowOnly))
{
throw new InvalidEnumArgumentException("value", (int)value, typeof(AutoSizeMode));
}
if (GetAutoSizeMode() != value) {
SetAutoSizeMode(value);
Control toLayout = DesignMode || ParentInternal == null ? this : ParentInternal;
if(toLayout != null) {
// DefaultLayout does not keep anchor information until it needs to. When
// AutoSize became a common property, we could no longer blindly call into
// DefaultLayout, so now we do a special InitLayout just for DefaultLayout.
if(toLayout.LayoutEngine == DefaultLayout.Instance) {
toLayout.LayoutEngine.InitLayout(this, BoundsSpecified.Size);
}
LayoutTransaction.DoLayout(toLayout, this, PropertyNames.AutoSize);
}
}
}
}
///
/// Indicates whether controls in this container will be automatically validated when the focus changes.
///
[
Browsable(true),
EditorBrowsable(EditorBrowsableState.Always),
]
public override AutoValidate AutoValidate {
get {
return base.AutoValidate;
}
set {
base.AutoValidate = value;
}
}
///
/// [To be supplied.]
///
[
Browsable(true),
EditorBrowsable(EditorBrowsableState.Always),
]
public new event EventHandler AutoValidateChanged {
add {
base.AutoValidateChanged += value;
}
remove {
base.AutoValidateChanged -= value;
}
}
///
///
/// Indicates the borderstyle for the UserControl.
///
///
[
SRCategory(SR.CatAppearance),
DefaultValue(BorderStyle.None),
SRDescription(SR.UserControlBorderStyleDescr),
Browsable(true), EditorBrowsable(EditorBrowsableState.Always)
]
public BorderStyle BorderStyle {
get {
return borderStyle;
}
set {
if (borderStyle != value) {
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)BorderStyle.None, (int)BorderStyle.Fixed3D))
{
throw new InvalidEnumArgumentException("value", (int)value, typeof(BorderStyle));
}
borderStyle = value;
UpdateStyles();
}
}
}
///
/// Returns the parameters needed to create the handle. Inheriting classes
/// can override this to provide extra functionality. They should not,
/// however, forget to call base.getCreateParams() first to get the struct
/// filled up with the basic info.This is required as we now need to pass the
/// styles for appropriate BorderStyle that is set by the user.
///
protected override CreateParams CreateParams {
[SecurityPermission(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.UnmanagedCode)]
get {
CreateParams cp = base.CreateParams;
cp.ExStyle |= NativeMethods.WS_EX_CONTROLPARENT;
cp.ExStyle &= (~NativeMethods.WS_EX_CLIENTEDGE);
cp.Style &= (~NativeMethods.WS_BORDER);
switch (borderStyle) {
case BorderStyle.Fixed3D:
cp.ExStyle |= NativeMethods.WS_EX_CLIENTEDGE;
break;
case BorderStyle.FixedSingle:
cp.Style |= NativeMethods.WS_BORDER;
break;
}
return cp;
}
}
///
/// The default size for this user control.
///
protected override Size DefaultSize {
get {
return new Size(150, 150);
}
}
///
/// Occurs before the control becomes visible.
///
[SRCategory(SR.CatBehavior), SRDescription(SR.UserControlOnLoadDescr)]
public event EventHandler Load {
add {
Events.AddHandler(EVENT_LOAD, value);
}
remove {
Events.RemoveHandler(EVENT_LOAD, value);
}
}
///
/// Validates all selectable child controls in the container, including descendants. This is
/// equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See
[Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
public override bool ValidateChildren() {
return base.ValidateChildren();
}
///
/// Validates all the child controls in the container. Exactly which controls are
/// validated and which controls are skipped is determined by
[Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
public override bool ValidateChildren(ValidationConstraints validationConstraints) {
return base.ValidateChildren(validationConstraints);
}
private bool FocusInside() {
if (!IsHandleCreated) return false;
IntPtr hwndFocus = UnsafeNativeMethods.GetFocus();
if (hwndFocus == IntPtr.Zero) return false;
IntPtr hwnd = Handle;
if (hwnd == hwndFocus || SafeNativeMethods.IsChild(new HandleRef(this, hwnd), new HandleRef(null, hwndFocus)))
return true;
return false;
}
///
/// Raises the CreateControl event.
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected override void OnCreateControl() {
base.OnCreateControl();
OnLoad(EventArgs.Empty);
}
///
/// The Load event is fired before the control becomes visible for the first time.
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void OnLoad(EventArgs e) {
// There is no good way to explain this event except to say
// that it's just another name for OnControlCreated.
EventHandler handler = (EventHandler)Events[EVENT_LOAD];
if (handler != null) handler(this,e);
}
///
/// OnResize override to invalidate entire control in Stetch mode
///
///
/// [To be supplied.]
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected override void OnMouseDown(MouseEventArgs e) {
if (!FocusInside())
FocusInternal();
base.OnMouseDown(e);
}
private void WmSetFocus(ref Message m) {
if (!HostedInWin32DialogManager) {
IntSecurity.ModifyFocus.Assert();
try {
if (ActiveControl == null)
SelectNextControl(null, true, true, true, false);
}
finally {
System.Security.CodeAccessPermission.RevertAssert();
}
}
if (!ValidationCancelled) {
base.WndProc(ref m);
}
}
///
/// [To be supplied.]
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
[SecurityPermission(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.UnmanagedCode)]
protected override void WndProc(ref Message m) {
switch (m.Msg) {
case NativeMethods.WM_SETFOCUS:
WmSetFocus(ref m);
break;
default:
base.WndProc(ref m);
break;
}
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
/*
*/
namespace System.Windows.Forms {
using Microsoft.Win32;
using System;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.ComponentModel.Design.Serialization;
using System.Diagnostics;
using System.Drawing;
using System.Runtime.InteropServices;
using System.Runtime.Remoting;
using System.Security.Permissions;
using System.Windows.Forms.Design;
using System.Windows.Forms.Layout;
///
/// Represents an empty control that can be used in the Forms Designer to create other controls. By extending form, UserControl inherits all of
/// the standard positioning and mnemonic handling code that is necessary
/// in a user control.
///
[
ComVisible(true),
ClassInterface(ClassInterfaceType.AutoDispatch),
Designer("System.Windows.Forms.Design.UserControlDocumentDesigner, " + AssemblyRef.SystemDesign, typeof(IRootDesigner)),
Designer("System.Windows.Forms.Design.ControlDesigner, " + AssemblyRef.SystemDesign),
DesignerCategory("UserControl"),
DefaultEvent("Load")
]
public class UserControl : ContainerControl {
private static readonly object EVENT_LOAD = new object();
private BorderStyle borderStyle = System.Windows.Forms.BorderStyle.None;
///
/// Creates a new UserControl object. A vast majority of people
/// will not want to instantiate this class directly, but will be a
/// sub-class of it.
///
public UserControl() {
SetScrollState(ScrollStateAutoScrolling, false);
SetState(STATE_VISIBLE, true);
SetState(STATE_TOPLEVEL, false);
SetStyle(ControlStyles.SupportsTransparentBackColor, true);
}
///
/// Override to re-expose AutoSize.
///
[Browsable(true), EditorBrowsable(EditorBrowsableState.Always),
DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
public override bool AutoSize
{
get
{
return base.AutoSize;
}
set
{
base.AutoSize = value;
}
}
///
/// Re-expose AutoSizeChanged.
///
[Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
public new event EventHandler AutoSizeChanged {
add {
base.AutoSizeChanged += value;
}
remove {
base.AutoSizeChanged -= value;
}
}
///
/// Allows the control to optionally shrink when AutoSize is true.
///
[
SRDescription(SR.ControlAutoSizeModeDescr),
SRCategory(SR.CatLayout),
Browsable(true),
DefaultValue(AutoSizeMode.GrowOnly),
Localizable(true)
]
public AutoSizeMode AutoSizeMode {
get {
return GetAutoSizeMode();
}
set {
if (!ClientUtils.IsEnumValid(value, (int)value, (int)AutoSizeMode.GrowAndShrink, (int)AutoSizeMode.GrowOnly))
{
throw new InvalidEnumArgumentException("value", (int)value, typeof(AutoSizeMode));
}
if (GetAutoSizeMode() != value) {
SetAutoSizeMode(value);
Control toLayout = DesignMode || ParentInternal == null ? this : ParentInternal;
if(toLayout != null) {
// DefaultLayout does not keep anchor information until it needs to. When
// AutoSize became a common property, we could no longer blindly call into
// DefaultLayout, so now we do a special InitLayout just for DefaultLayout.
if(toLayout.LayoutEngine == DefaultLayout.Instance) {
toLayout.LayoutEngine.InitLayout(this, BoundsSpecified.Size);
}
LayoutTransaction.DoLayout(toLayout, this, PropertyNames.AutoSize);
}
}
}
}
///
/// Indicates whether controls in this container will be automatically validated when the focus changes.
///
[
Browsable(true),
EditorBrowsable(EditorBrowsableState.Always),
]
public override AutoValidate AutoValidate {
get {
return base.AutoValidate;
}
set {
base.AutoValidate = value;
}
}
///
/// [To be supplied.]
///
[
Browsable(true),
EditorBrowsable(EditorBrowsableState.Always),
]
public new event EventHandler AutoValidateChanged {
add {
base.AutoValidateChanged += value;
}
remove {
base.AutoValidateChanged -= value;
}
}
///
///
/// Indicates the borderstyle for the UserControl.
///
///
[
SRCategory(SR.CatAppearance),
DefaultValue(BorderStyle.None),
SRDescription(SR.UserControlBorderStyleDescr),
Browsable(true), EditorBrowsable(EditorBrowsableState.Always)
]
public BorderStyle BorderStyle {
get {
return borderStyle;
}
set {
if (borderStyle != value) {
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)BorderStyle.None, (int)BorderStyle.Fixed3D))
{
throw new InvalidEnumArgumentException("value", (int)value, typeof(BorderStyle));
}
borderStyle = value;
UpdateStyles();
}
}
}
///
/// Returns the parameters needed to create the handle. Inheriting classes
/// can override this to provide extra functionality. They should not,
/// however, forget to call base.getCreateParams() first to get the struct
/// filled up with the basic info.This is required as we now need to pass the
/// styles for appropriate BorderStyle that is set by the user.
///
protected override CreateParams CreateParams {
[SecurityPermission(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.UnmanagedCode)]
get {
CreateParams cp = base.CreateParams;
cp.ExStyle |= NativeMethods.WS_EX_CONTROLPARENT;
cp.ExStyle &= (~NativeMethods.WS_EX_CLIENTEDGE);
cp.Style &= (~NativeMethods.WS_BORDER);
switch (borderStyle) {
case BorderStyle.Fixed3D:
cp.ExStyle |= NativeMethods.WS_EX_CLIENTEDGE;
break;
case BorderStyle.FixedSingle:
cp.Style |= NativeMethods.WS_BORDER;
break;
}
return cp;
}
}
///
/// The default size for this user control.
///
protected override Size DefaultSize {
get {
return new Size(150, 150);
}
}
///
/// Occurs before the control becomes visible.
///
[SRCategory(SR.CatBehavior), SRDescription(SR.UserControlOnLoadDescr)]
public event EventHandler Load {
add {
Events.AddHandler(EVENT_LOAD, value);
}
remove {
Events.RemoveHandler(EVENT_LOAD, value);
}
}
///
/// Validates all selectable child controls in the container, including descendants. This is
/// equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See
[Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
public override bool ValidateChildren() {
return base.ValidateChildren();
}
///
/// Validates all the child controls in the container. Exactly which controls are
/// validated and which controls are skipped is determined by
[Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
public override bool ValidateChildren(ValidationConstraints validationConstraints) {
return base.ValidateChildren(validationConstraints);
}
private bool FocusInside() {
if (!IsHandleCreated) return false;
IntPtr hwndFocus = UnsafeNativeMethods.GetFocus();
if (hwndFocus == IntPtr.Zero) return false;
IntPtr hwnd = Handle;
if (hwnd == hwndFocus || SafeNativeMethods.IsChild(new HandleRef(this, hwnd), new HandleRef(null, hwndFocus)))
return true;
return false;
}
///
/// Raises the CreateControl event.
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected override void OnCreateControl() {
base.OnCreateControl();
OnLoad(EventArgs.Empty);
}
///
/// The Load event is fired before the control becomes visible for the first time.
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void OnLoad(EventArgs e) {
// There is no good way to explain this event except to say
// that it's just another name for OnControlCreated.
EventHandler handler = (EventHandler)Events[EVENT_LOAD];
if (handler != null) handler(this,e);
}
///
/// OnResize override to invalidate entire control in Stetch mode
///
///
/// [To be supplied.]
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected override void OnMouseDown(MouseEventArgs e) {
if (!FocusInside())
FocusInternal();
base.OnMouseDown(e);
}
private void WmSetFocus(ref Message m) {
if (!HostedInWin32DialogManager) {
IntSecurity.ModifyFocus.Assert();
try {
if (ActiveControl == null)
SelectNextControl(null, true, true, true, false);
}
finally {
System.Security.CodeAccessPermission.RevertAssert();
}
}
if (!ValidationCancelled) {
base.WndProc(ref m);
}
}
///
/// [To be supplied.]
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
[SecurityPermission(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.UnmanagedCode)]
protected override void WndProc(ref Message m) {
switch (m.Msg) {
case NativeMethods.WM_SETFOCUS:
WmSetFocus(ref m);
break;
default:
base.WndProc(ref m);
break;
}
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- TextStore.cs
- DesignerTextViewAdapter.cs
- EventLogEntryCollection.cs
- EventWaitHandleSecurity.cs
- WaitHandleCannotBeOpenedException.cs
- OdbcParameterCollection.cs
- UniqueConstraint.cs
- RegexGroup.cs
- CodeSubDirectory.cs
- HwndSourceKeyboardInputSite.cs
- NameTable.cs
- StorageAssociationTypeMapping.cs
- LineInfo.cs
- SemanticResultValue.cs
- ErrorTolerantObjectWriter.cs
- DataMisalignedException.cs
- TileModeValidation.cs
- Int64Converter.cs
- CharEntityEncoderFallback.cs
- BuildDependencySet.cs
- CompositeControl.cs
- CompositeActivityValidator.cs
- ColumnReorderedEventArgs.cs
- HttpConfigurationContext.cs
- PointLightBase.cs
- EditorZoneDesigner.cs
- BitmapData.cs
- DataGridViewSelectedColumnCollection.cs
- StringBuilder.cs
- FixedSOMPage.cs
- ControlAdapter.cs
- Base64Encoding.cs
- CompilerWrapper.cs
- IfElseDesigner.xaml.cs
- BaseParser.cs
- ProbeMatchesCD1.cs
- tooltip.cs
- RegisterResponseInfo.cs
- SchemaRegistration.cs
- ADMembershipUser.cs
- WebServiceMethodData.cs
- PrimitiveType.cs
- XamlFigureLengthSerializer.cs
- StoreContentChangedEventArgs.cs
- DefaultSettingsSection.cs
- DeliveryRequirementsAttribute.cs
- PropertyCollection.cs
- PolyLineSegment.cs
- RegexRunner.cs
- EditorZone.cs
- OrderByQueryOptionExpression.cs
- MtomMessageEncoder.cs
- EventSinkHelperWriter.cs
- ClientConfigurationHost.cs
- PageStatePersister.cs
- _SingleItemRequestCache.cs
- LogicalTreeHelper.cs
- PackWebResponse.cs
- CodeCommentStatement.cs
- VisualTreeHelper.cs
- DependentList.cs
- SqlTopReducer.cs
- ConnectionManager.cs
- CodeAttachEventStatement.cs
- XmlSchemaExporter.cs
- ResourceReader.cs
- DataMember.cs
- ConstraintManager.cs
- Error.cs
- InfoCardRSAPKCS1SignatureFormatter.cs
- UIntPtr.cs
- StylusPointProperties.cs
- WebEventCodes.cs
- StylusPointCollection.cs
- SerialPort.cs
- TypographyProperties.cs
- TextTreeFixupNode.cs
- ValueType.cs
- NotEqual.cs
- DoubleLink.cs
- XamlDesignerSerializationManager.cs
- DBBindings.cs
- VisualStates.cs
- GeneralTransformGroup.cs
- FilterEventArgs.cs
- NTAccount.cs
- HtmlInputText.cs
- RuntimeArgument.cs
- ContentOperations.cs
- TextTreeUndo.cs
- MatrixTransform.cs
- HyperLinkField.cs
- UrlPath.cs
- InstanceHandleReference.cs
- DelegateSerializationHolder.cs
- TypeResolvingOptionsAttribute.cs
- TargetPerspective.cs
- XPathParser.cs
- EntitySetBase.cs
- ExtentCqlBlock.cs