Code:
/ Dotnetfx_Win7_3.5.1 / Dotnetfx_Win7_3.5.1 / 3.5.1 / DEVDIV / depot / DevDiv / releases / whidbey / NetFXspW7 / ndp / fx / src / CompMod / System / ComponentModel / Design / HelpKeywordAttribute.cs / 1 / HelpKeywordAttribute.cs
//------------------------------------------------------------------------------ //// Copyright (c) Microsoft Corporation. All rights reserved. // //----------------------------------------------------------------------------- /* */ namespace System.ComponentModel.Design { using System; using System.Security.Permissions; ////// Allows specification of the context keyword that will be specified for this class or member. By default, /// the help keyword for a class is the Type's full name, and for a member it's the full name of the type that declared the property, /// plus the property name itself. /// /// For example, consider System.Windows.Forms.Button and it's Text property: /// /// The class keyword is "System.Windows.Forms.Button", but the Text property keyword is "System.Windows.Forms.Control.Text", because the Text /// property is declared on the System.Windows.Forms.Control class rather than the Button class itself; the Button class inherits the property. /// By contrast, the DialogResult property is declared on the Button so its keyword would be "System.Windows.Forms.Button.DialogResult". /// /// When the help system gets the keywords, it will first look at this attribute. At the class level, it will return the string specified by the /// HelpContextAttribute. Note this will not be used for members of the Type in question. They will still reflect the declaring Type's actual /// full name, plus the member name. To override this, place the attribute on the member itself. /// /// Example: /// /// [HelpKeywordAttribute(typeof(Component))] /// public class MyComponent : Component { /// /// /// public string Property1 { get{return "";}; /// /// [HelpKeywordAttribute("SomeNamespace.SomeOtherClass.Property2")] /// public string Property2 { get{return "";}; /// /// } /// /// /// For the above class (default without attribution): /// /// Class keyword: "System.ComponentModel.Component" ("MyNamespace.MyComponent') /// Property1 keyword: "MyNamespace.MyComponent.Property1" (default) /// Property2 keyword: "SomeNamespace.SomeOtherClass.Property2" ("MyNamespace.MyComponent.Property2") /// /// [AttributeUsage(AttributeTargets.All, AllowMultiple = false, Inherited = false)] [Serializable] public sealed class HelpKeywordAttribute : Attribute { ////// Default value for HelpKeywordAttribute, which is null. /// public static readonly HelpKeywordAttribute Default = new HelpKeywordAttribute(); private string contextKeyword; ////// Default constructor, which creates an attribute with a null HelpKeyword. /// public HelpKeywordAttribute() { } ////// Creates a HelpKeywordAttribute with the value being the given keyword string. /// public HelpKeywordAttribute(string keyword) { if (keyword == null) { throw new ArgumentNullException("keyword"); } this.contextKeyword = keyword; } ////// Creates a HelpKeywordAttribute with the value being the full name of the given type. /// public HelpKeywordAttribute(Type t) { if (t == null) { throw new ArgumentNullException("t"); } this.contextKeyword = t.FullName; } ////// Retrieves the HelpKeyword this attribute supplies. /// public string HelpKeyword { get { return contextKeyword; } } ////// Two instances of a HelpKeywordAttribute are equal if they're HelpKeywords are equal. /// public override bool Equals(object obj) { if (obj == this) { return true; } if ((obj != null) && (obj is HelpKeywordAttribute)) { return ((HelpKeywordAttribute)obj).HelpKeyword == HelpKeyword; } return false; } ////// public override int GetHashCode() { return base.GetHashCode(); } ////// Returns true if this Attribute's HelpKeyword is null. /// public override bool IsDefaultAttribute() { return this.Equals(Default); } } } // File provided for Reference Use Only by Microsoft Corporation (c) 2007. //------------------------------------------------------------------------------ //// Copyright (c) Microsoft Corporation. All rights reserved. // //----------------------------------------------------------------------------- /* */ namespace System.ComponentModel.Design { using System; using System.Security.Permissions; ////// Allows specification of the context keyword that will be specified for this class or member. By default, /// the help keyword for a class is the Type's full name, and for a member it's the full name of the type that declared the property, /// plus the property name itself. /// /// For example, consider System.Windows.Forms.Button and it's Text property: /// /// The class keyword is "System.Windows.Forms.Button", but the Text property keyword is "System.Windows.Forms.Control.Text", because the Text /// property is declared on the System.Windows.Forms.Control class rather than the Button class itself; the Button class inherits the property. /// By contrast, the DialogResult property is declared on the Button so its keyword would be "System.Windows.Forms.Button.DialogResult". /// /// When the help system gets the keywords, it will first look at this attribute. At the class level, it will return the string specified by the /// HelpContextAttribute. Note this will not be used for members of the Type in question. They will still reflect the declaring Type's actual /// full name, plus the member name. To override this, place the attribute on the member itself. /// /// Example: /// /// [HelpKeywordAttribute(typeof(Component))] /// public class MyComponent : Component { /// /// /// public string Property1 { get{return "";}; /// /// [HelpKeywordAttribute("SomeNamespace.SomeOtherClass.Property2")] /// public string Property2 { get{return "";}; /// /// } /// /// /// For the above class (default without attribution): /// /// Class keyword: "System.ComponentModel.Component" ("MyNamespace.MyComponent') /// Property1 keyword: "MyNamespace.MyComponent.Property1" (default) /// Property2 keyword: "SomeNamespace.SomeOtherClass.Property2" ("MyNamespace.MyComponent.Property2") /// /// [AttributeUsage(AttributeTargets.All, AllowMultiple = false, Inherited = false)] [Serializable] public sealed class HelpKeywordAttribute : Attribute { ////// Default value for HelpKeywordAttribute, which is null. /// public static readonly HelpKeywordAttribute Default = new HelpKeywordAttribute(); private string contextKeyword; ////// Default constructor, which creates an attribute with a null HelpKeyword. /// public HelpKeywordAttribute() { } ////// Creates a HelpKeywordAttribute with the value being the given keyword string. /// public HelpKeywordAttribute(string keyword) { if (keyword == null) { throw new ArgumentNullException("keyword"); } this.contextKeyword = keyword; } ////// Creates a HelpKeywordAttribute with the value being the full name of the given type. /// public HelpKeywordAttribute(Type t) { if (t == null) { throw new ArgumentNullException("t"); } this.contextKeyword = t.FullName; } ////// Retrieves the HelpKeyword this attribute supplies. /// public string HelpKeyword { get { return contextKeyword; } } ////// Two instances of a HelpKeywordAttribute are equal if they're HelpKeywords are equal. /// public override bool Equals(object obj) { if (obj == this) { return true; } if ((obj != null) && (obj is HelpKeywordAttribute)) { return ((HelpKeywordAttribute)obj).HelpKeyword == HelpKeyword; } return false; } ////// public override int GetHashCode() { return base.GetHashCode(); } ////// Returns true if this Attribute's HelpKeyword is null. /// public override bool IsDefaultAttribute() { return this.Equals(Default); } } } // 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
- SystemIPv6InterfaceProperties.cs
- TextBoxBaseDesigner.cs
- Point3DIndependentAnimationStorage.cs
- CanExecuteRoutedEventArgs.cs
- CultureData.cs
- ComponentDispatcher.cs
- EditorZoneBase.cs
- SessionStateUtil.cs
- ColumnResizeUndoUnit.cs
- InvalidEnumArgumentException.cs
- FormDesigner.cs
- ConsoleKeyInfo.cs
- dsa.cs
- TextTreeInsertUndoUnit.cs
- SubMenuStyle.cs
- Or.cs
- IPAddress.cs
- SqlBuffer.cs
- COAUTHIDENTITY.cs
- ObjectFactoryCodeDomTreeGenerator.cs
- DoubleUtil.cs
- WeakReadOnlyCollection.cs
- CharEntityEncoderFallback.cs
- RefreshPropertiesAttribute.cs
- HttpWebRequest.cs
- RequestDescription.cs
- ToolStripItemTextRenderEventArgs.cs
- NamespaceCollection.cs
- ListItemCollection.cs
- WasAdminWrapper.cs
- Frame.cs
- GeneralTransform3DCollection.cs
- XmlSchemaDatatype.cs
- DbProviderFactory.cs
- PeekCompletedEventArgs.cs
- GridLength.cs
- LabelLiteral.cs
- X509SecurityTokenProvider.cs
- EventLogWatcher.cs
- ComplexType.cs
- EncoderNLS.cs
- InputScope.cs
- ScalarType.cs
- DefaultSerializationProviderAttribute.cs
- SimpleFileLog.cs
- FileAuthorizationModule.cs
- NativeWindow.cs
- WebControl.cs
- RuleSetBrowserDialog.cs
- WmlImageAdapter.cs
- CustomAttributeFormatException.cs
- GridView.cs
- ReflectPropertyDescriptor.cs
- RecoverInstanceLocksCommand.cs
- QilNode.cs
- GroupJoinQueryOperator.cs
- StringPropertyBuilder.cs
- Dispatcher.cs
- Stack.cs
- XmlNamespaceDeclarationsAttribute.cs
- EntityKeyElement.cs
- PowerStatus.cs
- glyphs.cs
- SimpleRecyclingCache.cs
- PropertyValue.cs
- ConfigsHelper.cs
- LabelTarget.cs
- CapabilitiesAssignment.cs
- CultureInfo.cs
- TextOptions.cs
- TargetControlTypeCache.cs
- ListGeneralPage.cs
- ListView.cs
- NotImplementedException.cs
- DelegatedStream.cs
- ExpressionContext.cs
- AbstractDataSvcMapFileLoader.cs
- UnsafeNativeMethodsTablet.cs
- ServiceXNameTypeConverter.cs
- NominalTypeEliminator.cs
- X509Utils.cs
- ZipIOCentralDirectoryDigitalSignature.cs
- GridViewHeaderRowPresenterAutomationPeer.cs
- OleDbWrapper.cs
- CalendarAutomationPeer.cs
- ImplicitInputBrush.cs
- RowBinding.cs
- ListViewDeletedEventArgs.cs
- SQLDateTime.cs
- XmlWellformedWriter.cs
- BindingBase.cs
- QuaternionAnimation.cs
- SqlProfileProvider.cs
- PrintControllerWithStatusDialog.cs
- PanelContainerDesigner.cs
- PopupEventArgs.cs
- XDRSchema.cs
- TCPListener.cs
- WindowsAuthenticationModule.cs
- ListManagerBindingsCollection.cs