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
- ProgressBar.cs
- SafeProcessHandle.cs
- PersonalizationEntry.cs
- ResourceSet.cs
- QilTargetType.cs
- DataViewManager.cs
- SqlDataSourceWizardForm.cs
- AsymmetricAlgorithm.cs
- WasEndpointConfigContainer.cs
- StringArrayConverter.cs
- DbCommandDefinition.cs
- OperationCanceledException.cs
- DependentTransaction.cs
- WorkflowPersistenceContext.cs
- SafeHandle.cs
- Variant.cs
- CodeTypeDeclaration.cs
- FormatException.cs
- HtmlTableRow.cs
- QueryCursorEventArgs.cs
- XmlArrayItemAttributes.cs
- TextRange.cs
- DbProviderConfigurationHandler.cs
- GB18030Encoding.cs
- Char.cs
- TimerElapsedEvenArgs.cs
- EditingMode.cs
- XmlAggregates.cs
- ApplicationInterop.cs
- _NetRes.cs
- XmlStreamNodeWriter.cs
- XmlLanguageConverter.cs
- OciLobLocator.cs
- UnmanagedMemoryStream.cs
- X509SecurityTokenAuthenticator.cs
- PackagePartCollection.cs
- DesigntimeLicenseContext.cs
- StringOutput.cs
- ImageSourceConverter.cs
- HwndSource.cs
- ValidateNames.cs
- XmlSchemaInclude.cs
- SQLResource.cs
- UnsafeNativeMethodsTablet.cs
- CryptoConfig.cs
- NativeWindow.cs
- IntSecurity.cs
- PackageRelationshipCollection.cs
- CacheChildrenQuery.cs
- BigInt.cs
- InstanceDataCollectionCollection.cs
- LinqTreeNodeEvaluator.cs
- TiffBitmapEncoder.cs
- TransformPattern.cs
- SimpleType.cs
- StorageMappingItemCollection.cs
- DSACryptoServiceProvider.cs
- CodeMethodInvokeExpression.cs
- DefinitionUpdate.cs
- UrlPropertyAttribute.cs
- CodeGeneratorOptions.cs
- XmlRootAttribute.cs
- MetadataException.cs
- ObjectQueryExecutionPlan.cs
- TeredoHelper.cs
- ListViewVirtualItemsSelectionRangeChangedEvent.cs
- HtmlTernaryTree.cs
- PtsPage.cs
- StylusLogic.cs
- CustomCategoryAttribute.cs
- ProxyElement.cs
- SqlDataSourceQueryEditor.cs
- AddingNewEventArgs.cs
- GridViewCancelEditEventArgs.cs
- EqualityArray.cs
- MappingException.cs
- TakeOrSkipWhileQueryOperator.cs
- SR.cs
- SyntaxCheck.cs
- SqlBuffer.cs
- AnonymousIdentificationSection.cs
- DocumentViewerBase.cs
- HttpWebResponse.cs
- CodeGen.cs
- ConfigXmlAttribute.cs
- _SslState.cs
- SafeHandle.cs
- WSTrustDec2005.cs
- Parser.cs
- StrongNameHelpers.cs
- HttpModule.cs
- TextElementCollection.cs
- ExplicitDiscriminatorMap.cs
- ScrollPattern.cs
- LazyTextWriterCreator.cs
- ConnectionStringsExpressionBuilder.cs
- VectorAnimation.cs
- DataKey.cs
- SaveFileDialog.cs
- Row.cs