Code:
/ 4.0 / 4.0 / DEVDIV_TFS / Dev10 / Releases / RTMRel / ndp / fx / src / CompMod / System / ComponentModel / Design / HelpKeywordAttribute.cs / 1305376 / 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
- AlignmentXValidation.cs
- ToolboxDataAttribute.cs
- DecimalAnimation.cs
- WorkflowItemPresenter.cs
- InheritanceAttribute.cs
- TransactedReceiveScope.cs
- Models.cs
- Marshal.cs
- UpdatePanelTriggerCollection.cs
- ValidationEventArgs.cs
- GenericEnumerator.cs
- MethodAccessException.cs
- JoinGraph.cs
- ProjectionPathBuilder.cs
- JobStaple.cs
- ContentPropertyAttribute.cs
- StoryFragments.cs
- FormatterConverter.cs
- EditCommandColumn.cs
- CodeSubDirectory.cs
- PenCursorManager.cs
- SerializationStore.cs
- KeyToListMap.cs
- XmlProcessingInstruction.cs
- HyperLinkField.cs
- ClientSideQueueItem.cs
- TextShapeableCharacters.cs
- PersonalizationProvider.cs
- ValuePattern.cs
- PageThemeCodeDomTreeGenerator.cs
- WorkflowInstanceUnhandledExceptionRecord.cs
- ValidationVisibilityAttribute.cs
- InfoCardArgumentException.cs
- StrokeNodeOperations2.cs
- ArrangedElementCollection.cs
- SettingsProperty.cs
- CollectionExtensions.cs
- MarkedHighlightComponent.cs
- MessageQuerySet.cs
- DBDataPermission.cs
- _AcceptOverlappedAsyncResult.cs
- TreeBuilderBamlTranslator.cs
- ExpressionBindingCollection.cs
- ValidationPropertyAttribute.cs
- SiteMapDataSourceDesigner.cs
- Binding.cs
- documentsequencetextview.cs
- DynamicFilterExpression.cs
- X509Certificate2.cs
- BitmapInitialize.cs
- Ray3DHitTestResult.cs
- Byte.cs
- MetadataPropertyAttribute.cs
- _ProxyRegBlob.cs
- MachineKeySection.cs
- ConstraintStruct.cs
- WebBrowserUriTypeConverter.cs
- XmlHierarchyData.cs
- OleDbTransaction.cs
- WeakReference.cs
- PropertyMap.cs
- XhtmlBasicSelectionListAdapter.cs
- CacheRequest.cs
- Point3DKeyFrameCollection.cs
- LineBreak.cs
- HtmlInputButton.cs
- TrackingProfileSerializer.cs
- cookiecontainer.cs
- _NegotiateClient.cs
- Brush.cs
- GC.cs
- NodeInfo.cs
- Vector3DAnimationBase.cs
- GenericNameHandler.cs
- ProxyGenerator.cs
- RouteItem.cs
- NoPersistHandle.cs
- IndexerNameAttribute.cs
- ObjectConverter.cs
- NamespaceQuery.cs
- OleDbWrapper.cs
- CollectionBuilder.cs
- DateTimeOffsetConverter.cs
- ScalarConstant.cs
- AdjustableArrowCap.cs
- ServerValidateEventArgs.cs
- TypedElement.cs
- InstanceLockTracking.cs
- Vector3D.cs
- DetailsViewInsertedEventArgs.cs
- CodeAttributeArgument.cs
- NominalTypeEliminator.cs
- VirtualDirectoryMapping.cs
- SqlExpander.cs
- EndpointPerformanceCounters.cs
- ComponentResourceKeyConverter.cs
- Parameter.cs
- Util.cs
- TypeProvider.cs
- DataListItemCollection.cs