Sdílet prostřednictvím

Property – příkaz

  • Článek

Deklaruje název vlastnosti a vlastnosti postupy používané k ukládání a načítání hodnoty vlastnosti.

[ <attributelist> ] [ Default ] [ accessmodifier ] 
[ propertymodifiers ] [ Shared ] [ Shadows ] [ ReadOnly | WriteOnly ] [ Iterator ]
Property name ( [ parameterlist ] ) [ As returntype ] [ Implements implementslist ]
    [ <attributelist> ] [ accessmodifier ] Get
        [ statements ]
    End Get
    [ <attributelist> ] [ accessmodifier ] Set ( ByVal value As returntype [, parameterlist ] )
        [ statements ]
    End Set
End Property
- or -
[ <attributelist> ] [ Default ] [ accessmodifier ] 
[ propertymodifiers ] [ Shared ] [ Shadows ] [ ReadOnly | WriteOnly ] 
Property name ( [ parameterlist ] ) [ As returntype ] [ Implements implementslist ]

Části

Termín

Definice

attributelist

Nepovinné.Seznam atributů, které platí pro tuto vlastnost nebo Get nebo Set postup.Viz seznam atributů.

Default

Nepovinné.Určuje, že tato vlastnost je výchozí vlastnost třídy nebo struktury, který je definován.Výchozí vlastnosti musí přijímat parametry a lze nastavit a je načtena bez určení názvu vlastnosti.Pokud deklarujete vlastnost jako Default, nelze použít Private na vlastnost nebo na některou z jeho vlastností postupy.

accessmodifier

Nepovinné na Property prohlášení a nanejvýš jednu ze Get a Set příkazy.Může být jeden z následujících:

Viz téma Úrovně přístupu v jazyce Visual Basic.

propertymodifiers

Nepovinné.Může být jeden z následujících:

Shared

Nepovinné.Viz téma Shared (Visual Basic).

Shadows

Nepovinné.Viz téma Shadows (Visual Basic).

ReadOnly

Nepovinné.Viz téma ReadOnly (Visual Basic).

WriteOnly

Nepovinné.Viz téma WriteOnly (Visual Basic).

Iterator

Nepovinné.Viz iterační.

name

Povinné.Název vlastnosti.Viz téma Deklarované názvy elementu (Visual Basic).

parameterlist

Nepovinné.Seznam místní proměnné názvy představující parametry této vlastnosti a možné další parametry Set postup.Viz téma Seznam parametrů (Visual Basic).

returntype

Required if OptionStrict is On.Typ dat hodnoty vrácené touto vlastností.

Implements

Nepovinné.Označuje, že tato vlastnost implementuje jednu nebo více vlastností a každý z nich definované v rozhraní obsahující třídy nebo struktury této vlastnosti.Viz téma Implements – Příkaz.

implementslist

Vyžadován, pokud Implements se dodává.Seznam vlastností, které jsou implementovány.

implementedproperty [ , implementedproperty ... ]

Každý implementedproperty má následující syntaxi a částí:

interface.definedname

Část

Description

interface

Povinné.Obsahující název rozhraní implementováno touto vlastností třídy nebo struktury.

definedname

Povinné.Název, kterým je vlastnost definována v interface.

Get

Nepovinné.Požadováno, pokud je vlastnost označen WriteOnly.Spustí Get vlastnost procedura, která je použita pro vrácení hodnoty vlastnosti.

statements

Nepovinné.Blok příkazů spustit v rámci Get nebo Set postup.

End Get

Ukončí Get vlastnost postup.

Set

Nepovinné.Požadováno, pokud je vlastnost označen ReadOnly.Spustí Set vlastnost postup, který se používá k uložení hodnoty vlastnosti.

End Set

Ukončí Set vlastnost postup.

End Property

Ukončí vymezení této vlastnosti.

Poznámky

Property Příkaz uvádí deklarace vlastnosti.Vlastnosti Get (pouze pro čtení), postup Set postup (pouze pro zápis) nebo obě (read-write).Můžete vynechat Get a Set postup při použití vlastnosti provedena automaticky.Další informace naleznete v tématu Automaticky implementované vlastnosti (Visual Basic).

Můžete použít Property pouze na úrovni třídy.To znamená prohlášení kontextu pro vlastnost musí být třída, struktura, modulu nebo rozhraní a nemůže být zdrojový soubor, obor názvů, postup nebo blok.Další informace naleznete v tématu Kontexty deklarace a výchozí úrovně přístupu (Visual Basic).

Ve výchozím nastavení používají vlastnosti přístup veřejnosti.Můžete upravit na úroveň přístupu vlastnosti s modifikátor přístupu nastaven Property prohlášení a volitelně upravit jeden z jeho vlastností postupy přísnější úroveň přístupu.

Parametr předává jazyka Visual Basic Set postup při přiřazení vlastností.Pokud nezadáte parametr pro Set, integrované vývojové prostředí (IDE) se používá implicitní parametr s názvem value.Tento parametr obsahuje hodnotu vlastnosti přiřadit.Obvykle hodnotu v privátní místní proměnné a vrátit jej vždy, když Get volání procedury.

Pravidla

  • Smíšené úrovně přístupu. Pokud definujete vlastnost pro čtení a zápis, můžete určit úroveň přístupu různých volitelně buď Get nebo Set postup, ale ne obojí.Je-li to provést, musí být více omezující než úroveň přístupu je vlastnost úroveň řízení přístupu.Například pokud je vlastnost deklarována Friend, můžete deklarovat Set postup Private, ale ne Public.

    Pokud definujete ReadOnly nebo WriteOnly vlastnost, jedinou vlastnost postup (Get nebo Set, resp.) představuje všechny vlastnosti.Nelze deklarovat úroveň přístup jiný postup, protože by, nastavte vlastnost dvě úrovně přístupu.

  • **Vrátí typ.**Property Prohlášení deklarovat datový typ hodnoty, vrátí.Můžete zadat libovolný datový typ nebo název výčtu, struktura, třídy nebo rozhraní.

    Pokud nezadáte returntype, vrátí vlastnost Object.

  • Implementace. Pokud tato vlastnost se používá Implements musí mít klíčové slovo obsahující třídy nebo struktury Implements bezprostředně následující prohlášení jeho Class nebo Structure prohlášení.Implements Musí zahrnovat všechna rozhraní v implementslist.Však název, kterým definuje rozhraní Property (v definedname) nemusí být stejný jako název této vlastnosti (v name).

Chování

  • Po návratu z postupu vlastnost. Když Get nebo Set postup vrátí volající kód, pokračuje zpracování příkazem následující prohlášení, která vyvolala.

    Exit Property a Return příkazy z postupu vlastnost způsobit okamžité ukončení.Libovolný počet Exit Property a Return příkazy můžete umístit na libovolné místo v postupu, můžete se a Exit Property a Return příkazy.

  • Vrácená hodnota. Vrátit hodnotu z Get postup, můžete přiřadit název vlastnosti hodnotu nebo ji zahrnout Return prohlášení.Následující příklad přiřadí vrácenou hodnotu názvu vlastnosti quoteForTheDay a použije Exit Property příkaz vrátit.

    Private quoteValue As String = "No quote assigned yet."

    ReadOnly Property quoteForTheDay() As String 
    Get
        quoteForTheDay = quoteValue
        Exit Property 
    End Get 
End Property

    Pokud používáte Exit Property bez přiřazení hodnoty k name, Get procedura vrací výchozí hodnota pro typ dat vlastnosti.

    Return Příkaz současně přiřazuje Get postupu vraťte hodnotu a postup ukončen.To ukazuje následující příklad.

    Private quoteValue As String = "No quote assigned yet."

    ReadOnly Property quoteForTheDay() As String 
    Get 
        Return quoteValue
    End Get 
End Property

Příklad

Následující příklad deklaruje vlastnost ve třídě.

Class Class1
    ' Define a local variable to store the property value. 
    Private propertyValue As String 
    ' Define the property. 
    Public Property prop1() As String 
        Get 
            ' The Get property procedure is called when the value 
            ' of a property is retrieved. 
            Return propertyValue
        End Get 
        Set(ByVal value As String)
            ' The Set property procedure is called when the value  
            ' of a property is modified.  The value to be assigned 
            ' is passed in the argument to Set.
            propertyValue = value
        End Set 
    End Property 
End Class

Viz také

Referenční dokumentace

Get – příkaz

Set – příkaz (Visual Basic)

Seznam parametrů (Visual Basic)

Výchozí (Visual Basic)

Koncepty

Automaticky implementované vlastnosti (Visual Basic)

Další zdroje

Objekty a třídy v jazyce Visual Basic