Code:
/ Net / Net / 3.5.50727.3053 / DEVDIV / depot / DevDiv / releases / whidbey / netfxsp / 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
- UInt64.cs
- SplitContainer.cs
- objectresult_tresulttype.cs
- ThicknessAnimation.cs
- ObjectListCommand.cs
- DecimalConverter.cs
- GridSplitter.cs
- TagPrefixInfo.cs
- XslAst.cs
- TypeSystem.cs
- ObjectViewEntityCollectionData.cs
- ProcessProtocolHandler.cs
- SettingsPropertyNotFoundException.cs
- ManipulationDelta.cs
- OLEDB_Util.cs
- SecurityKeyIdentifier.cs
- CapabilitiesState.cs
- SafeCryptContextHandle.cs
- SiteOfOriginContainer.cs
- HeaderPanel.cs
- DelegatingTypeDescriptionProvider.cs
- ClosableStream.cs
- XmlSchemaInferenceException.cs
- TraceSection.cs
- RangeContentEnumerator.cs
- WindowsListBox.cs
- Models.cs
- ErrorWebPart.cs
- ProjectedSlot.cs
- TargetConverter.cs
- IgnoreFileBuildProvider.cs
- RemotingException.cs
- CaseExpr.cs
- LinqDataSourceContextData.cs
- DragDropManager.cs
- SchemaTableColumn.cs
- WebPartDescription.cs
- DataSourceProvider.cs
- BuiltInPermissionSets.cs
- OdbcRowUpdatingEvent.cs
- HMACSHA384.cs
- UseLicense.cs
- UpDownBase.cs
- ToolStripItemClickedEventArgs.cs
- ProjectionPathBuilder.cs
- ProfileGroupSettings.cs
- AnimatedTypeHelpers.cs
- NamespaceEmitter.cs
- QueueProcessor.cs
- Point4DValueSerializer.cs
- MulticastDelegate.cs
- AuditLogLocation.cs
- Int64Converter.cs
- WasHttpHandlersInstallComponent.cs
- CommandBinding.cs
- XPathNodeIterator.cs
- ContentElementAutomationPeer.cs
- WebPartRestoreVerb.cs
- PtsHelper.cs
- XmlNamespaceManager.cs
- FunctionDetailsReader.cs
- DetailsViewCommandEventArgs.cs
- DbgUtil.cs
- Encoding.cs
- BamlLocalizabilityResolver.cs
- DataGridViewColumnCollectionEditor.cs
- PointCollection.cs
- WCFModelStrings.Designer.cs
- SettingsAttributeDictionary.cs
- PrimitiveType.cs
- input.cs
- SetIterators.cs
- DataExpression.cs
- GregorianCalendar.cs
- AccessKeyManager.cs
- DateTimeOffset.cs
- CharacterShapingProperties.cs
- RectangleHotSpot.cs
- ThreadExceptionDialog.cs
- PassportAuthenticationEventArgs.cs
- ServiceManager.cs
- MetafileHeader.cs
- BinaryObjectWriter.cs
- SqlCacheDependency.cs
- DocumentViewerBaseAutomationPeer.cs
- CodeIdentifier.cs
- ProcessHostConfigUtils.cs
- ParseNumbers.cs
- DataSourceCache.cs
- SizeF.cs
- HtmlShimManager.cs
- SmtpMail.cs
- XhtmlTextWriter.cs
- Sql8ConformanceChecker.cs
- ComponentEvent.cs
- TextEditorTables.cs
- LayoutEvent.cs
- PageHandlerFactory.cs
- ISessionStateStore.cs
- ThicknessAnimationBase.cs