Share via


IPropertySymbol 介面

定義

表示屬性或索引子。

public interface class IPropertySymbol : IEquatable<Microsoft::CodeAnalysis::ISymbol ^>, Microsoft::CodeAnalysis::ISymbol
public interface IPropertySymbol : IEquatable<Microsoft.CodeAnalysis.ISymbol>, Microsoft.CodeAnalysis.ISymbol
type IPropertySymbol = interface
    interface ISymbol
    interface IEquatable<ISymbol>
Public Interface IPropertySymbol
Implements IEquatable(Of ISymbol), ISymbol
實作

備註

此介面會保留供其相關聯的 API 實作使用。 我們保留未來變更它的權利。

屬性

CanBeReferencedByName

如果此符號可以在程式碼中依其名稱參考,則傳回 true。

(繼承來源 ISymbol)
ContainingAssembly

IAssemblySymbol取得包含元件的 。 如果符號在多個元件之間共用,則傳回 null。

(繼承來源 ISymbol)
ContainingModule

IModuleSymbol取得包含模組的 。 如果符號在多個模組之間共用,則傳回 null。

(繼承來源 ISymbol)
ContainingNamespace

INamespaceSymbol取得最接近封入命名空間的 。 如果符號未包含在命名空間中,則傳回 null。

(繼承來源 ISymbol)
ContainingSymbol

ISymbol取得立即包含符號之 的 。

(繼承來源 ISymbol)
ContainingType

INamedTypeSymbol取得包含型別的 。 如果符號未包含在類型內,則傳回 null。

(繼承來源 ISymbol)
DeclaredAccessibility

取得 , Accessibility 表示符號的宣告協助工具。 如果未宣告協助工具,則會傳回 NotApplicable。

(繼承來源 ISymbol)
DeclaringSyntaxReferences

取得語法節點 () 此符號在來源中宣告的位置。 例如,某些符號 (,部分類別) 可能會定義在多個位置。 只有當符號在原始程式碼中宣告,而且未隱含宣告時,此屬性才應該傳回一或多個語法節點, (請參閱 IsImplicitlyDeclared 屬性) 。

請注意,針對命名空間符號,宣告語法可能會宣告巢狀命名空間。 例如,「namespace N1」 中 N1 的宣告語法節點。N2 {...}」 是 N1 的整個 NamespaceDeclarationSyntax。N2. 針對全域命名空間,宣告語法會是 CompilationUnitSyntax。

(繼承來源 ISymbol)
ExplicitInterfaceImplementations

傳回這個屬性明確實作的介面屬性。

GetMethod

屬性的 'get' 存取子,如果屬性是唯讀的,則為 null。

HasUnsupportedMetadata

表示此符號使用語言無法支援的中繼資料。

範例包括:

  • VB 中的指標類型
  • ByRef 傳回類型
  • 必要的自訂修飾詞

例如,這與未參考之元件中定義的中繼資料符號參考不同。 傳回 true 的符號永遠無法成功使用,因此不應該出現在任何 IDE 功能中。

這是針對中繼資料符號所設定,如下所示:

  • 類型 - 例如,如果不支援類型 (,則指標類型)
  • 方法 - 不支援參數或傳回類型
  • 欄位 - 不支援類型
  • 事件 - 不支援類型
  • 屬性 - 不支援類型
  • 參數 - 不支援類型
(繼承來源 ISymbol)
IsAbstract

取得值,指出符號是否為抽象。

(繼承來源 ISymbol)
IsDefinition

取得值,指出符號是否為原始定義。 如果符號衍生自另一個符號,則傳回 false,方法是依實例的型別替代。

(繼承來源 ISymbol)
IsExtern

取得值,指出符號是否在外部定義。

(繼承來源 ISymbol)
IsImplicitlyDeclared

如果編譯器自動建立此符號,而且沒有明確的對應原始程式碼宣告,則傳回 true。

(繼承來源 ISymbol)
IsIndexer

傳回屬性是否真的是索引子。

IsOverride

取得值,指出符號是否為基類符號的覆寫。

(繼承來源 ISymbol)
IsReadOnly

如果這是唯讀屬性,則為 True;也就是說,沒有 set 存取子的屬性。

IsRequired

如果在建構期間必須在物件初始化運算式中設定此屬性,則為 True。

IsSealed

取得值,指出符號是否密封。

(繼承來源 ISymbol)
IsStatic

取得值,指出符號是否為靜態。

(繼承來源 ISymbol)
IsVirtual

取得值,指出符號是否為虛擬。

(繼承來源 ISymbol)
IsWithEvents

如果此屬性是自動建立的 WithEvents 屬性,當欄位標示為 WithEvents 時,會傳回 true。

IsWriteOnly

如果這是唯寫屬性,則為 True;也就是說,沒有 get 存取子的屬性。

Kind

取得 , SymbolKind 表示其為何種符號。

(繼承來源 ISymbol)
Language

取得來來源語言 (「C#」 或 「Visual Basic」) 。

(繼承來源 ISymbol)
Locations

取得最初在來源或中繼資料中定義符號的位置。 例如,某些符號 (,部分類別) 可能會定義在多個位置。

(繼承來源 ISymbol)
MetadataName

取得出現在中繼資料中的符號名稱。 在大部分情況下,這與 Name 屬性相同,但有下列例外狀況:

  1. 泛型型別的中繼資料名稱包含 「'1」、「'2」 等尾碼,指出其不包含類型參數數目 (但不包含類型或命名空間的名稱) 。
  2. 相較于 name 屬性,明確介面名稱的中繼資料名稱已移除空格。
  3. 名稱長度限制為不超過中繼資料限制。
(繼承來源 ISymbol)
MetadataToken

取得與此符號相關聯的元資料標記,如果未從中繼資料載入符號,則為 0。

(繼承來源 ISymbol)
Name

取得符號名稱。 如果未命名,則傳回空字串。

(繼承來源 ISymbol)
NullableAnnotation

表示屬性或索引子。

OriginalDefinition

屬性的原始定義。 如果依類型替代從另一個符號建構屬性,則 OriginalDefinition 會取得原始符號,如同在來源或中繼資料中定義。

OverriddenProperty

傳回覆寫的屬性或 Null。

Parameters

這個屬性的參數。 如果這個屬性沒有參數,則會傳回空的清單。 參數只存在於索引子上,或存在於從 COM 介面匯入的某些屬性上。

RefCustomModifiers

與 ref 修飾詞相關聯的自訂修飾詞,如果沒有,則為空陣列。

RefKind

傳回 屬性的 RefKind。

ReturnsByRef

如果這個屬性以傳址方式傳回,則會傳回 true。

ReturnsByRefReadonly

如果這個屬性以唯讀變數傳回,則會傳回 true。

SetMethod

屬性的 'set' 存取子,如果屬性是唯讀的,則為 null。

Type

屬性的類型。

TypeCustomModifiers

與屬性類型相關聯的自訂修飾詞清單。

方法

Accept(SymbolVisitor)

表示屬性或索引子。

(繼承來源 ISymbol)
Accept<TArgument,TResult>(SymbolVisitor<TArgument,TResult>, TArgument)

表示屬性或索引子。

(繼承來源 ISymbol)
Accept<TResult>(SymbolVisitor<TResult>)

表示屬性或索引子。

(繼承來源 ISymbol)
Equals(ISymbol, SymbolEqualityComparer)

根據提供的規則,判斷此符號是否等於另一個符號 SymbolEqualityComparer

(繼承來源 ISymbol)
GetAttributes()

取得符號的屬性。 如果沒有屬性,則傳回空 IEnumerable<T> 的 。

(繼承來源 ISymbol)
GetDocumentationCommentId()

傳回符號的檔批註識別碼,如果符號不支援檔批註,則傳回 null。

(繼承來源 ISymbol)
GetDocumentationCommentXml(CultureInfo, Boolean, CancellationToken)

取得 XML (做為與符號相關聯之批註的文字) 。

(繼承來源 ISymbol)
ToDisplayParts(SymbolDisplayFormat)

將符號轉換成字串部分的陣列,每個元件都有一種。 適用于將顯示字串著色。

(繼承來源 ISymbol)
ToDisplayString(SymbolDisplayFormat)

將符號轉換為字串表示。

(繼承來源 ISymbol)
ToMinimalDisplayParts(SemanticModel, Int32, SymbolDisplayFormat)

將符號轉換成字串部分的陣列,每個元件都有一種。 可以針對原始程式碼中的特定位置量身打造。 適用于將顯示字串著色。

(繼承來源 ISymbol)
ToMinimalDisplayString(SemanticModel, Int32, SymbolDisplayFormat)

將符號轉換成可以向使用者顯示的字串。 可以針對原始程式碼中的特定位置量身打造。

(繼承來源 ISymbol)

擴充方法

IsDefault(IPropertySymbol)

表示屬性或索引子。

IsMustOverride(ISymbol)

表示屬性或索引子。

IsNotOverridable(ISymbol)

表示屬性或索引子。

IsOverloads(IPropertySymbol)

表示屬性或索引子。

IsOverridable(ISymbol)

表示屬性或索引子。

IsOverrides(ISymbol)

表示屬性或索引子。

IsShared(ISymbol)

判斷符號是否為共用。

適用於