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
- Run.cs
- TemplatedControlDesigner.cs
- ColumnClickEvent.cs
- ProgressBar.cs
- Rect.cs
- WebConfigurationHost.cs
- Vector3dCollection.cs
- DataServiceException.cs
- ApplicationSecurityManager.cs
- ValidationRuleCollection.cs
- XmlDocumentSchema.cs
- ProtocolsConfigurationEntry.cs
- RegionIterator.cs
- isolationinterop.cs
- CaseExpr.cs
- ClientOptions.cs
- SimpleHandlerBuildProvider.cs
- XmlStreamStore.cs
- propertyentry.cs
- TraceLevelStore.cs
- AsyncDataRequest.cs
- EntityObject.cs
- ExtendedProtectionPolicy.cs
- Attachment.cs
- TextElement.cs
- ScrollItemPattern.cs
- TerminateDesigner.cs
- TimerElapsedEvenArgs.cs
- WindowsPrincipal.cs
- CodeExporter.cs
- DbConnectionStringBuilder.cs
- StructuralCache.cs
- SchemaNames.cs
- WsdlBuildProvider.cs
- GeometryConverter.cs
- HtmlTextArea.cs
- CachedRequestParams.cs
- SecurityTokenException.cs
- ScrollPatternIdentifiers.cs
- DataGridTextBoxColumn.cs
- ConnectionStringsExpressionBuilder.cs
- TTSEvent.cs
- PermissionSet.cs
- PackWebRequestFactory.cs
- DWriteFactory.cs
- OdbcConnectionStringbuilder.cs
- AnchorEditor.cs
- PolicyLevel.cs
- BitmapEffectCollection.cs
- LinqDataSourceInsertEventArgs.cs
- ClientOptions.cs
- NativeMethods.cs
- State.cs
- XamlStream.cs
- EdmItemError.cs
- ObjectQuery.cs
- ThreadStartException.cs
- ClientEventManager.cs
- WsdlBuildProvider.cs
- DataGridTableStyleMappingNameEditor.cs
- ScrollChrome.cs
- BaseDataListDesigner.cs
- SoapIncludeAttribute.cs
- ConnectionsZone.cs
- XmlnsDefinitionAttribute.cs
- DelegateTypeInfo.cs
- PrimitiveDataContract.cs
- DataListCommandEventArgs.cs
- BaseAsyncResult.cs
- HasCopySemanticsAttribute.cs
- Tile.cs
- ProxyGenerator.cs
- InvalidEnumArgumentException.cs
- XamlTreeBuilderBamlRecordWriter.cs
- PathFigureCollection.cs
- TemplateBaseAction.cs
- UnaryNode.cs
- TextElementEnumerator.cs
- PagesSection.cs
- ProtocolViolationException.cs
- EFColumnProvider.cs
- EmissiveMaterial.cs
- XD.cs
- BuildProvider.cs
- WhiteSpaceTrimStringConverter.cs
- TreeViewEvent.cs
- XmlRawWriterWrapper.cs
- Soap12FormatExtensions.cs
- XmlTextAttribute.cs
- SplineKeyFrames.cs
- EntityStoreSchemaGenerator.cs
- OdbcConnectionStringbuilder.cs
- Configuration.cs
- HttpPostedFileWrapper.cs
- AppSettings.cs
- DelayedRegex.cs
- CheckoutException.cs
- XmlWrappingWriter.cs
- ControlUtil.cs
- _OSSOCK.cs