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
- _SecureChannel.cs
- SymLanguageType.cs
- ConnectionsZone.cs
- CustomWebEventKey.cs
- WpfGeneratedKnownTypes.cs
- ArrangedElementCollection.cs
- StrokeNodeOperations2.cs
- MatrixAnimationBase.cs
- ExportOptions.cs
- wgx_render.cs
- HandledEventArgs.cs
- PropertySegmentSerializer.cs
- DataSourceView.cs
- FilteredXmlReader.cs
- DesigntimeLicenseContextSerializer.cs
- ViewCellSlot.cs
- ClonableStack.cs
- GenericAuthenticationEventArgs.cs
- IteratorFilter.cs
- EventLog.cs
- MenuAdapter.cs
- WebControlParameterProxy.cs
- Compiler.cs
- SizeValueSerializer.cs
- StructuralCache.cs
- IOThreadScheduler.cs
- XmlLoader.cs
- Part.cs
- EventsTab.cs
- PropertyToken.cs
- SiteMapDataSourceView.cs
- TextEffectResolver.cs
- Mapping.cs
- CopyEncoder.cs
- GenericParameterDataContract.cs
- SendingRequestEventArgs.cs
- Helpers.cs
- MsmqBindingMonitor.cs
- DetailsViewUpdateEventArgs.cs
- StorageEntityContainerMapping.cs
- DefaultWorkflowTransactionService.cs
- OracleDateTime.cs
- WebResourceAttribute.cs
- VBCodeProvider.cs
- TypedTableBase.cs
- Row.cs
- CorrelationResolver.cs
- CFStream.cs
- DeclaredTypeElementCollection.cs
- RelationshipDetailsRow.cs
- OledbConnectionStringbuilder.cs
- RootProfilePropertySettingsCollection.cs
- XmlWrappingWriter.cs
- StaticExtension.cs
- SiteMapPath.cs
- Matrix3D.cs
- AdornerLayer.cs
- WindowsSpinner.cs
- ZipFileInfo.cs
- RoleGroupCollection.cs
- HttpCacheVaryByContentEncodings.cs
- CalendarButton.cs
- HtmlElementEventArgs.cs
- Brush.cs
- DefaultBindingPropertyAttribute.cs
- StructuredType.cs
- Rect.cs
- UnsafeNativeMethods.cs
- HtmlShim.cs
- XmlSchemaAll.cs
- ToolStripArrowRenderEventArgs.cs
- SettingsPropertyNotFoundException.cs
- VarInfo.cs
- DataRowChangeEvent.cs
- TextElementCollection.cs
- Hyperlink.cs
- FrameSecurityDescriptor.cs
- XPathNodeIterator.cs
- SecurityElement.cs
- EdmEntityTypeAttribute.cs
- QuaternionAnimation.cs
- DataColumnPropertyDescriptor.cs
- MessageQueue.cs
- XpsDocumentEvent.cs
- GeometryConverter.cs
- UnsafeNetInfoNativeMethods.cs
- InvalidFilterCriteriaException.cs
- HandledEventArgs.cs
- DataGridViewButtonColumn.cs
- autovalidator.cs
- WebException.cs
- XmlUTF8TextWriter.cs
- figurelength.cs
- GeneralTransform3DGroup.cs
- PopupEventArgs.cs
- BinHexEncoding.cs
- GestureRecognitionResult.cs
- SrgsRulesCollection.cs
- EditorPartChrome.cs
- CacheDependency.cs