Freigeben über

@microsoft/sp-property-pane package

SharePoint-Framework Eigenschaftenbereich.

Schnittstellen

IDynamicDataSharedPropertyConfiguration

Konfiguration im Zusammenhang mit einer freigegebenen Eigenschaft.
IDynamicDataSharedPropertyFilters

Dynamische Dateneigenschaftenfilter im Eigenschaftenbereich.
IDynamicDataSharedSourceConfiguration

Konfiguration im Zusammenhang mit einer freigegebenen Quelle.
IDynamicDataSharedSourceFilters

Dynamische Datenquellenfilter im Eigenschaftenbereich.
IGuidSet

Gruppe von GUIDs, die ein Listenelement darstellen.
IPopupWindowProps

Popupfenstereigenschaften.
IPropertyPaneButtonProps

Eigenschaften der PropertyPane-Schaltfläche.
IPropertyPaneCheckboxProps

PropertyPane-CheckBox-Komponenteneigenschaften.
IPropertyPaneChoiceGroupOption

PropertyPane-ChoiceGroup-Optionseigenschaften.
IPropertyPaneChoiceGroupOptionIconProps

Eigenschaften des PropertyPane ChoiceGroup-Symbols.
IPropertyPaneChoiceGroupProps

PropertyPane-ChoiceGroup-Eigenschaften.
IPropertyPaneConditionalGroup

Bedingte Gruppe des Eigenschaftenbereichs.
IPropertyPaneConfiguration

Webpart-Konfigurationseinstellungen
IPropertyPaneCustomFieldProps

PropertyPane CustomPropertyField-Eigenschaften
IPropertyPaneDebounceProperty

Definition einer Eigenschaft des Eigenschaftenbereichs, für die das onPropertyPaneFieldChanged Ereignis debounced werden soll.
IPropertyPaneDropdownCalloutProps

PropertyPane-Dropdownbeschriftungseigenschaften.
IPropertyPaneDropdownOption

PropertyPane-Dropdown-Optionen.
IPropertyPaneDropdownProps

PropertyPane-Dropdown-Komponenteneigenschaften.
IPropertyPaneDynamicFieldProps

PropertyPaneDynamicField-Eigenschaften.
IPropertyPaneDynamicFieldSetProps

PropertyPane DynamicFieldSet-Eigenschaften.
IPropertyPaneDynamicTextFieldProps

PropertyPaneDynamicData Komponenteneigenschaften.
IPropertyPaneField

PropertyPane-Feld.
IPropertyPaneGroup

PropertyPane-Gruppe. Gruppe ist Teil der PropertyPanePage.
IPropertyPaneHeadingProps

Eigenschaften der PropertyPaneHeader-Komponente.
IPropertyPaneIconPickerProps

Eigenschaften für PropertyPaneIconPicker-Komponenten
IPropertyPaneLabelProps

PropertyPaneLabel-Komponenteneigenschaften.
IPropertyPaneLinkProps

PropertyPaneLink-Komponenteneigenschaften.
IPropertyPanePage

PropertyPanePage-Schnittstelle.
IPropertyPanePageHeader

PropertyPane-Kopfzeile. Diese Kopfzeile ist für alle Seiten identisch.
IPropertyPaneSliderProps

PropertyPaneSliderProps-Komponenteneigenschaften.
IPropertyPaneSpinButtonProps

Eigenschaften der PropertyPaneSpinButton-Komponente.
IPropertyPaneTextFieldProps

PropertyPaneTextField-Komponenteneigenschaften.
IPropertyPaneThumbnailPickerProps

Eigenschaften der PropertyPaneThumbnailPicker-Komponente
IPropertyPaneToggleProps

PropertyPaneToggle-Komponenteneigenschaften.
IThumbnailFabricReactIcon

Optionen im Zusammenhang mit der Miniaturansicht des Fabric-Symbols.
IThumbnailIconSizeImage

Optionen im Zusammenhang mit der Miniaturansicht eines Bilds mit Symbolgröße.
IThumbnailImage

Optionen im Zusammenhang mit der Miniaturansicht des Bilds.

Typaliase

ImageFit

Die möglichen Methoden, die zum Anpassen des Bilds verwendet werden können.
IPropertyPaneDynamicFieldFilters

Dynamische Feldfilter im Eigenschaftenbereich, die eine Schnittmenge von Quell- und Eigenschaftsfiltern darstellen.
IThumbnail

Der Typ des zu konfigurierenden Miniaturbilds.
PropertyPaneHeadingLevel

Typ für die Überschriftenebenen, h1-h6
ThumbnailType

Unterstützte Miniaturbildtypen.

Enumerationen

DynamicDataSharedDepth

Enumeration für die möglichen Werte der freigegebenen Tiefe des dynamischen Datenverweises.
PagesType

Seitenanzeigetyp für den Eigenschaftenbereich mit mehreren Seiten.
PopupWindowPosition

Die Position des Popupfensters.
PropertyPaneButtonType

Aufzählung für alle unterstützten Schaltflächentypen.
PropertyPaneDropdownOptionType

Gibt den Typ der Option in einem Dropdownmenü an, das von PropertyPaneDropdown() gerendert wird.
PropertyPaneFieldType

Enumeration für alle unterstützten PropertyPane-Feldtypen.

Namen sollten mit denen in office-ui-fabric-react konsistent sein, achten Sie darauf, dass Sie die Groß-und Kleinschreibung ordnungsgemäß verwenden.

Functions

PropertyPaneButton(targetProperty, properties)

Hilfsmethode zum Erstellen einer Schaltfläche im PropertyPane.
PropertyPaneCheckbox(targetProperty, properties)

Hilfsmethode zum Erstellen eines Kontrollkästchens im PropertyPane.
PropertyPaneChoiceGroup(targetProperty, properties)

Hilfsmethode zum Erstellen einer Auswahlgruppe im PropertyPane.
PropertyPaneCustomField(properties)

Hilfsmethode zum Erstellen eines benutzerdefinierten Felds im PropertyPane.
PropertyPaneDropdown(targetProperty, properties)

Hilfsmethode zum Erstellen eines Dropdowns im PropertyPane.
PropertyPaneDynamicField(targetProperty, properties)

Hilfsmethode zum Erstellen eines Dynamischen Datenwidgets im PropertyPane für ein dynamisches Feld.
PropertyPaneDynamicFieldSet(properties)

Hilfsmethode zum Erstellen eines Widgets für dynamische Daten im Eigenschaftenbereich für einen Satz dynamischer Felder mit einer gemeinsamen Datenquelle.

Diese Felder können basierend auf den zugeordneten Filtern möglicherweise dieselbe Eigenschaft verwenden.
PropertyPaneDynamicTextField(targetProperty, properties)

Hilfsmethode zum Erstellen eines dynamischen TextField-Objekts im PropertyPane.Helper method to create a Dynamic TextField on the PropertyPane.
PropertyPaneHeading(targetProperty, properties)

Hilfsmethode zum Erstellen einer Überschrift im PropertyPane. Temporäre Lösung beim Warten auf die Neugestaltung
PropertyPaneHorizontalRule()

Hilfsmethode zum Erstellen einer horizontalen Regel im PropertyPane.
PropertyPaneIconPicker(targetProperty, properties)

Hilfsmethode zum Erstellen eines IconPicker-Elements im PropertyPane.
PropertyPaneLabel(targetProperty, properties)

Hilfsmethode zum Erstellen einer Beschriftung im PropertyPane.
PropertyPaneLink(targetProperty, properties)

Hilfsmethode zum Erstellen eines Links im PropertyPane.
PropertyPaneSlider(targetProperty, properties)

Hilfsmethode zum Erstellen eines Schiebereglers im PropertyPane.
PropertyPaneSpinButton(targetProperty, properties)

Hilfsmethode zum Erstellen eines SpinButton-Objekts im Eigenschaftenbereich.
PropertyPaneTextField(targetProperty, properties)

Hilfsmethode zum Erstellen eines TextField im PropertyPane.
PropertyPaneThumbnailPicker(targetProperty, properties)

Hilfsmethode zum Erstellen eines ThumbnailPicker-Objekts im PropertyPane.
PropertyPaneToggle(targetProperty, properties)

Hilfsmethode zum Erstellen einer Umschaltfläche im PropertyPane.

Details zur Funktion

PropertyPaneButton(targetProperty, properties)

Hilfsmethode zum Erstellen einer Schaltfläche im PropertyPane.

export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField<IPropertyPaneButtonProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der die Button verknüpft ist.

properties
IPropertyPaneButtonProps

Button-Eigenschaften mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneButtonProps>

PropertyPaneCheckbox(targetProperty, properties)

Hilfsmethode zum Erstellen eines Kontrollkästchens im PropertyPane.

export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField<IPropertyPaneCheckboxProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der das Kontrollkästchen verknüpft ist.

properties
IPropertyPaneCheckboxProps

Eigenschaften von Kontrollkästchen mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneCheckboxProps>

PropertyPaneChoiceGroup(targetProperty, properties)

Hilfsmethode zum Erstellen einer Auswahlgruppe im PropertyPane.

export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField<IPropertyPaneChoiceGroupProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der die Auswahlgruppe verknüpft ist.

properties
IPropertyPaneChoiceGroupProps

Auswahlgruppeneigenschaften mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneChoiceGroupProps>

PropertyPaneCustomField(properties)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Hilfsmethode zum Erstellen eines benutzerdefinierten Felds im PropertyPane.

export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField<IPropertyPaneCustomFieldProps>;

Parameter

properties
IPropertyPaneCustomFieldProps

Stark typisierte Benutzerdefinierte Feldeigenschaften.

Gibt zurück

IPropertyPaneField<IPropertyPaneCustomFieldProps>

Hinweise

Der Zweck des benutzerdefinierten Felds besteht darin, dem Webpartentwickler zu helfen, dem PropertyPane ein benutzerdefiniertes Steuerelement hinzuzufügen. PropertyPane unterstützt eine Vielzahl von integrierten Feldtypen. Diese Liste erfüllt zwar die Anforderungen der meisten Webparts, aber es gibt Ausnahmefälle, in denen Webparts besondere Anforderungen haben und ein spezielles Steuerelement benötigen. Das benutzerdefinierte Feld hilft dabei, diese Lücke zu schließen.

PropertyPaneDropdown(targetProperty, properties)

Hilfsmethode zum Erstellen eines Dropdowns im PropertyPane.

export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField<IPropertyPaneDropdownProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der das Dropdown verknüpft ist.

properties
IPropertyPaneDropdownProps

Dropdown-Eigenschaften mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneDropdownProps>

PropertyPaneDynamicField(targetProperty, properties)

Hilfsmethode zum Erstellen eines Dynamischen Datenwidgets im PropertyPane für ein dynamisches Feld.

export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField<IPropertyPaneDynamicFieldProps>;

Parameter

targetProperty

string

Zieleigenschaft, der das Dynamic Data-Widget zugeordnet ist.

properties
IPropertyPaneDynamicFieldProps

Gibt zurück

IPropertyPaneField<IPropertyPaneDynamicFieldProps>

PropertyPaneDynamicFieldSet(properties)

Hilfsmethode zum Erstellen eines Widgets für dynamische Daten im Eigenschaftenbereich für einen Satz dynamischer Felder mit einer gemeinsamen Datenquelle.

Diese Felder können basierend auf den zugeordneten Filtern möglicherweise dieselbe Eigenschaft verwenden.

export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>;

Parameter

properties
IPropertyPaneDynamicFieldSetProps

Enthält Einträge und Optionen, die wie unten beschrieben werden: Einträge : Ein Satz von Einträgen, die vom Widget konfiguriert werden sollen. Jeder Eintrag enthält die Zieleigenschaft und optional die anzuzeigende Bezeichnung. Options: Optionen, die benutzerdefinierte Werte für Rückrufe, Filter usw. für den angegebenen Satz dynamischer Felder aktivieren.

Gibt zurück

IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>

PropertyPaneDynamicTextField(targetProperty, properties)

Warnung

Diese API ist nun veraltet.

  • This has been replaced by PropertyPaneDynamicField

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Hilfsmethode zum Erstellen eines dynamischen TextField-Objekts im PropertyPane.Helper method to create a Dynamic TextField on the PropertyPane.

export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>;

Parameter

targetProperty

string

Zieleigenschaft, der das dynamische Textfeld zugeordnet ist.

properties
IPropertyPaneDynamicTextFieldProps

Eigenschaften des PropertyPaneDynamicTextField.

Gibt zurück

IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>

PropertyPaneHeading(targetProperty, properties)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Hilfsmethode zum Erstellen einer Überschrift im PropertyPane. Temporäre Lösung beim Warten auf die Neugestaltung

export declare function PropertyPaneHeading(targetProperty: string, properties: IPropertyPaneHeadingProps): IPropertyPaneField<IPropertyPaneHeadingProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der die Beschriftung verknüpft ist.

properties
IPropertyPaneHeadingProps

Label-Eigenschaften mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneHeadingProps>

PropertyPaneHorizontalRule()

Hilfsmethode zum Erstellen einer horizontalen Regel im PropertyPane.

export declare function PropertyPaneHorizontalRule(): IPropertyPaneField<void>;

Gibt zurück

IPropertyPaneField<void>

PropertyPaneIconPicker(targetProperty, properties)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Hilfsmethode zum Erstellen eines IconPicker-Elements im PropertyPane.

export declare function PropertyPaneIconPicker(targetProperty: string, properties: IPropertyPaneIconPickerProps): IPropertyPaneField<IPropertyPaneIconPickerProps>;

Parameter

targetProperty

string

Zieleigenschaft, der die Symbolauswahl zugeordnet ist.

properties
IPropertyPaneIconPickerProps

Stark typisierte IconPicker-Eigenschaften.

Gibt zurück

IPropertyPaneField<IPropertyPaneIconPickerProps>

PropertyPaneLabel(targetProperty, properties)

Hilfsmethode zum Erstellen einer Beschriftung im PropertyPane.

export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField<IPropertyPaneLabelProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der die Beschriftung verknüpft ist.

properties
IPropertyPaneLabelProps

Label-Eigenschaften mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneLabelProps>

Hilfsmethode zum Erstellen eines Links im PropertyPane.

export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField<IPropertyPaneLinkProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der der Link verknüpft ist.

properties
IPropertyPaneLinkProps

Link-Eigenschaften mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneLinkProps>

PropertyPaneSlider(targetProperty, properties)

Hilfsmethode zum Erstellen eines Schiebereglers im PropertyPane.

export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField<IPropertyPaneSliderProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der der Schieberegler verknüpft ist.

properties
IPropertyPaneSliderProps

Slider-Eigenschaften mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneSliderProps>

PropertyPaneSpinButton(targetProperty, properties)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Hilfsmethode zum Erstellen eines SpinButton-Objekts im Eigenschaftenbereich.

export declare function PropertyPaneSpinButton(targetProperty: string, properties: IPropertyPaneSpinButtonProps): IPropertyPaneField<IPropertyPaneSpinButtonProps>;

Parameter

targetProperty

string

Zieleigenschaft, der die Drehschaltfläche zugeordnet ist.

properties
IPropertyPaneSpinButtonProps

Stark typisierte Spin-Button-Eigenschaften.

Gibt zurück

IPropertyPaneField<IPropertyPaneSpinButtonProps>

PropertyPaneTextField(targetProperty, properties)

Hilfsmethode zum Erstellen eines TextField im PropertyPane.

export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField<IPropertyPaneTextFieldProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der das TextField verknüpft ist.

properties
IPropertyPaneTextFieldProps

TextField-Eigenschaften mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneTextFieldProps>

PropertyPaneThumbnailPicker(targetProperty, properties)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Hilfsmethode zum Erstellen eines ThumbnailPicker-Objekts im PropertyPane.

export declare function PropertyPaneThumbnailPicker(targetProperty: string, properties: IPropertyPaneThumbnailPickerProps): IPropertyPaneField<IPropertyPaneThumbnailPickerProps>;

Parameter

targetProperty

string

Zieleigenschaft, der die Miniaturansichtsauswahl zugeordnet ist.

properties
IPropertyPaneThumbnailPickerProps

Stark typisierte ThumbnailPicker-Eigenschaften.

Gibt zurück

IPropertyPaneField<IPropertyPaneThumbnailPickerProps>

PropertyPaneToggle(targetProperty, properties)

Hilfsmethode zum Erstellen einer Umschaltfläche im PropertyPane.

export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField<IPropertyPaneToggleProps>;

Parameter

targetProperty

string

Zieleigenschaft, mit der der Toggle verknüpft ist.

properties
IPropertyPaneToggleProps

Toggle-Eigenschaften mit starkem Typ.

Gibt zurück

IPropertyPaneField<IPropertyPaneToggleProps>