HelpKeywordAttribute Klas

Definitie

Naamruimte:: System.ComponentModel.Design

Assembly:: System.dll

Assembly:: netstandard.dll

Belangrijk

Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.

Hiermee geeft u het contextwoord voor een klasse of lid. Deze klasse kan niet worden overgenomen.

public ref class HelpKeywordAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)]
[System.Serializable]
public sealed class HelpKeywordAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)]
public sealed class HelpKeywordAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)>]
[<System.Serializable>]
type HelpKeywordAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)>]
type HelpKeywordAttribute = class
    inherit Attribute

Public NotInheritable Class HelpKeywordAttribute
Inherits Attribute

Overname: Object

Attribute
HelpKeywordAttribute

Kenmerken: AttributeUsageAttribute SerializableAttribute

Voorbeelden

In het volgende codevoorbeeld ziet u hoe u dit Help-systeemgedrag overschrijft door het kenmerk op het lid zelf te plaatsen. Dit zijn de trefwoorden voor de volgende klasse, genaamd DemoComponent:

Trefwoord klasse: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)
Trefwoord Eigenschap1: "DemoNamespace.DemoComponent.Property1" (standaard)
Trefwoord Eigenschap2: "SomeNamespace.SomeOtherClass.Property2" (DemoNamespace.DemoComponent.Property2)

[HelpKeywordAttribute(typeof(Component))]
public class DemoComponent : Component
{
    public string Property1
    {
        get
        {
            return "";
        }
    }

    [HelpKeywordAttribute("SomeNamespace.SomeOtherClass.Property2")]
    public string Property2
    {
        get
        {
            return "";
        }
    }
}

In het volgende codevoorbeeld ziet u hoe u de HelpKeywordAttribute klasse gebruikt om een contextwoord op te geven. Zie How to: Apply Attributes in Windows Forms Controls voor een volledige uitleg van dit codevoorbeeld.

// This control demonstrates a simple logging capability.
[ComplexBindingProperties("DataSource", "DataMember")]
[DefaultBindingProperty("TitleText")]
[DefaultEvent("ThresholdExceeded")]
[DefaultProperty("Threshold")]
[HelpKeyword(typeof(UserControl))]
[ToolboxItem("System.Windows.Forms.Design.AutoSizeToolboxItem,System.Design")]
public class AttributesDemoControl : UserControl
{

' This control demonstrates a simple logging capability. 
<ComplexBindingProperties("DataSource", "DataMember"), _
DefaultBindingProperty("TitleText"), _
DefaultEvent("ThresholdExceeded"), _
DefaultProperty("Threshold"), _
HelpKeywordAttribute(GetType(UserControl)), _
ToolboxItem("System.Windows.Forms.Design.AutoSizeToolboxItem,System.Design")> _
Public Class AttributesDemoControl
    Inherits UserControl

Opmerkingen

Standaard wordt het Help-trefwoord voor een klasse gegeven door de Type.FullName eigenschapswaarde. Voor leden wordt het Trefwoord Help gegeven door de volledige naam van het type dat de eigenschap heeft gedeclareerd, plus de naam van de eigenschap zelf.

Denk bijvoorbeeld aan de eigenschap Control.Text in het besturingselement System.Windows.Forms.Button. Het trefwoord klasse is 'Systeem. Windows. Forms.Button, maar het trefwoord van de eigenschap Control.Text is Systeem. Windows. Forms.Control.Text", omdat de eigenschap Control.Text is gedeclareerd in de klasse System.Windows.Forms.Control, in plaats van de klasse System.Windows.Forms.Button zelf; de System.Windows.Forms.Button-klasse neemt de eigenschap over.

De eigenschap Button.DialogResult wordt daarentegen gedeclareerd in de klasse System.Windows.Forms.Button, dus het trefwoord is Systeem. Windows. Forms.Button.DialogResult'.

Wanneer het Help-systeem de trefwoorden krijgt, wordt er eerst naar gekeken HelpKeywordAttribute. Op klasseniveau wordt de tekenreeks geretourneerd die is opgegeven door de HelpKeywordAttribute. Dit wordt niet gebruikt voor leden van het betreffende type, dat nog steeds de werkelijke volledige naam van het type weergeeft, plus de naam van het lid. Dit kenmerk ondersteunt sterk getypte klassen die algemene documentatie hebben gekoppeld, maar afzonderlijke Help-id's.

Constructors

Name	Description
HelpKeywordAttribute()	Initialiseert een nieuw exemplaar van de HelpKeywordAttribute klasse.
HelpKeywordAttribute(String)	Initialiseert een nieuw exemplaar van de HelpKeywordAttribute klasse.
HelpKeywordAttribute(Type)	Initialiseert een nieuw exemplaar van de HelpKeywordAttribute klasse van het opgegeven type.

Velden

Name	Description
Default	Vertegenwoordigt de standaardwaarde voor HelpKeywordAttribute. Dit veld is alleen-lezen.

Eigenschappen

Name	Description
HelpKeyword	Hiermee haalt u het Help-trefwoord op dat door dit kenmerk is opgegeven.
TypeId	Wanneer deze wordt geïmplementeerd in een afgeleide klasse, krijgt u Attributehiervoor een unieke id. (Overgenomen van Attribute)

Methoden

Name	Description
Equals(Object)	Bepaalt of twee HelpKeywordAttribute exemplaren gelijk zijn.
GetHashCode()	Retourneert de hash-code voor dit exemplaar.
GetType()	Hiermee haalt u de Type huidige instantie op. (Overgenomen van Object)
IsDefaultAttribute()	Bepaalt of het Trefwoord Help is `null`.
Match(Object)	Wanneer deze wordt overschreven in een afgeleide klasse, wordt een waarde geretourneerd die aangeeft of dit exemplaar gelijk is aan een opgegeven object. (Overgenomen van Attribute)
MemberwiseClone()	Hiermee maakt u een ondiepe kopie van de huidige Object. (Overgenomen van Object)
ToString()	Retourneert een tekenreeks die het huidige object vertegenwoordigt. (Overgenomen van Object)

Expliciete interface-implementaties

Name	Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Hiermee wordt een set namen toegewezen aan een bijbehorende set verzend-id's. (Overgenomen van Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Hiermee haalt u de typegegevens voor een object op, die kan worden gebruikt om de typegegevens voor een interface op te halen. (Overgenomen van Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Hiermee wordt het aantal type-informatieinterfaces opgehaald dat een object biedt (0 of 1). (Overgenomen van Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Biedt toegang tot eigenschappen en methoden die door een object worden weergegeven. (Overgenomen van Attribute)

Van toepassing op

Feedback

Is deze pagina nuttig?