NonStandardBuilderAdd Method

Adds a NonStandardProperty instance, which is newly initialized using the specified arguments, to the NonStandards property.

Definition

Namespace: FolkerKinzel.VCards.BuilderParts
Assembly: FolkerKinzel.VCards (in FolkerKinzel.VCards.dll) Version: 8.0.1+a91cc3f0fd39aeb548e16006a60ca9dd10a304a2

C#

public VCardBuilder Add(
	string key,
	string? value,
	Action<ParameterSection>? parameters = null,
	Func<VCard, string?>? group = null
)

VB

Public Function Add ( 
	key As String,
	value As String,
	Optional parameters As Action(Of ParameterSection) = Nothing,
	Optional group As Func(Of VCard, String) = Nothing
) As VCardBuilder

C++

public:
VCardBuilder^ Add(
	String^ key, 
	String^ value, 
	Action<ParameterSection^>^ parameters = nullptr, 
	Func<VCard^, String^>^ group = nullptr
)

F#

member Add : 
        key : string * 
        value : string * 
        ?parameters : Action<ParameterSection> * 
        ?group : Func<VCard, string> 
(* Defaults:
        let _parameters = defaultArg parameters null
        let _group = defaultArg group null
*)
-> VCardBuilder

Parameters

key String: The key ("name") of the non-standard vCard property (format: X-NAME).
value String: The value of the vCard property: any data encoded as String or null.
parameters ActionParameterSection (Optional): An ActionT delegate that's invoked with the ParameterSection of the newly created VCardProperty as argument.
group FuncVCard, String (Optional): A function that returns the identifier of the group of VCardProperty objects, which the VCardProperty should belong to, or null to indicate that the VCardProperty does not belong to any group. The function is called with the VCard instance as argument.

Return Value

VCardBuilder
The VCardBuilder instance that initialized this NonStandardBuilder to be able to chain calls.

Remarks

If the arguments are not valid, an empty NonStandardProperty with the key "Empty" will be added. In any case such a NonStandardProperty won't be written to a VCF file.

Exceptions

InvalidOperationException

The method has been called on an instance that had been initialized using the default constructor.