Code:
/ Dotnetfx_Vista_SP2 / Dotnetfx_Vista_SP2 / 8.0.50727.4016 / DEVDIV / depot / DevDiv / releases / whidbey / NetFxQFE / 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
- StrokeRenderer.cs
- ClientUrlResolverWrapper.cs
- ButtonBase.cs
- KerberosTicketHashIdentifierClause.cs
- ObjectDataSourceView.cs
- DataRecordInternal.cs
- OledbConnectionStringbuilder.cs
- GraphicsPathIterator.cs
- PowerStatus.cs
- DataSourceSelectArguments.cs
- XmlReader.cs
- GlobalAllocSafeHandle.cs
- Light.cs
- FrameworkContentElementAutomationPeer.cs
- TargetControlTypeCache.cs
- PopupEventArgs.cs
- DataSetSchema.cs
- CorrelationTokenTypeConvertor.cs
- MemberNameValidator.cs
- HtmlEmptyTagControlBuilder.cs
- HealthMonitoringSection.cs
- DataKeyArray.cs
- BasicExpandProvider.cs
- DiscardableAttribute.cs
- TextBoxRenderer.cs
- HttpTransportElement.cs
- LightweightCodeGenerator.cs
- TextEditorTables.cs
- ValueOfAction.cs
- SQLBytes.cs
- _NativeSSPI.cs
- InfoCardSymmetricCrypto.cs
- UserControl.cs
- ProfileService.cs
- Visitor.cs
- HtmlTableCell.cs
- OrderByBuilder.cs
- UIElementHelper.cs
- MessageDispatch.cs
- HandlerElement.cs
- HandlerFactoryWrapper.cs
- AdornerLayer.cs
- WhitespaceSignificantCollectionAttribute.cs
- DomainUpDown.cs
- Directory.cs
- IQueryable.cs
- RadioButtonList.cs
- ServiceModelExtensionElement.cs
- StringUtil.cs
- AddingNewEventArgs.cs
- SocketInformation.cs
- MessageSecurityOverHttp.cs
- PropertyEntry.cs
- _Win32.cs
- HeaderPanel.cs
- PointAnimationClockResource.cs
- ArgumentOutOfRangeException.cs
- InheritanceAttribute.cs
- DataGridHeaderBorder.cs
- ButtonFieldBase.cs
- TemplateXamlTreeBuilder.cs
- Listener.cs
- InProcStateClientManager.cs
- DocumentPage.cs
- FileUtil.cs
- BitmapImage.cs
- EndPoint.cs
- PerformanceCounterTraceRecord.cs
- DocumentApplication.cs
- RemoteWebConfigurationHost.cs
- InternalDispatchObject.cs
- Tuple.cs
- BrowserInteropHelper.cs
- CharacterBuffer.cs
- MimeFormatter.cs
- HyperLink.cs
- HwndSourceKeyboardInputSite.cs
- XmlDocumentType.cs
- ISFClipboardData.cs
- DropTarget.cs
- ResourceReader.cs
- ClientConfigPaths.cs
- relpropertyhelper.cs
- CompressEmulationStream.cs
- TypeToken.cs
- BidOverLoads.cs
- ShaderEffect.cs
- TrailingSpaceComparer.cs
- CharAnimationBase.cs
- ResourceBinder.cs
- RelatedEnd.cs
- NeutralResourcesLanguageAttribute.cs
- HttpCacheVary.cs
- DiscoveryInnerClientAdhoc11.cs
- InteropBitmapSource.cs
- DesignerDataRelationship.cs
- XsdBuildProvider.cs
- EmbossBitmapEffect.cs
- XamlStackWriter.cs
- CrossSiteScriptingValidation.cs