MetadataDefaults.SetFieldDefault - Méthode (SPFolder, String, String)

Article
03/15/2016

Définit la valeur par défaut pour un champ à un emplacement.

Espace de noms : Microsoft.Office.DocumentManagement
Assembly : Microsoft.Office.DocumentManagement (dans Microsoft.Office.DocumentManagement.dll)

Syntaxe

'Déclaration
Public Function SetFieldDefault ( _
    folder As SPFolder, _
    fieldName As String, _
    value As String _
) As Boolean
'Utilisation
Dim instance As MetadataDefaults
Dim folder As SPFolder
Dim fieldName As String
Dim value As String
Dim returnValue As Boolean

returnValue = instance.SetFieldDefault(folder, _
    fieldName, value)

public bool SetFieldDefault(
    SPFolder folder,
    string fieldName,
    string value
)

Paramètres

folder
Type : Microsoft.SharePoint.SPFolder

emplacement de SPFolder à laquelle définir la valeur par défaut

fieldName
Type : System.String

Nom interne de l'objet SPField pour lequel définir la valeur par défaut

value
Type : System.String

La valeur par défaut

Valeur renvoyée

Type : System.Boolean
true en cas de réussite ; dans le cas contraire, false

Exceptions

Exception	Condition
ArgumentNullException	Le paramètre folder est défini à une référence Null (Rien dans Visual Basic). Le paramètre folder doit être un objet non null SPFolder qui représente un dossier dans la bibliothèque de documents. (ArgumentNullException.ParamName="folder")
ArgumentNullException	Le paramètre fieldName est défini sur une référence Null (Rien dans Visual Basic) ou la valeur String.Empty. Le paramètre fieldName doit être un nom interne d'un champ dans la bibliothèque de documents. (ArgumentNullException.ParamName="fieldName")
ArgumentNullException	Le paramètre value est défini sur une référence Null (Rien dans Visual Basic) ou la valeur String.Empty. Le paramètre value doit être la valeur par défaut qui est appliquée à l'objet spécifié SPField sur les documents ajoutés à ce dossier. (ArgumentNullException.ParamName="value")

Remarques

Cette méthode définit une valeur par défaut d'un champ à appliquer aux documents ajoutés à l'emplacement spécifié. La valeur doit être appropriée pour le type du champ qu'est définie sur la valeur par défaut. Par exemple, une chaîne de DateTime pour un objet SPFieldDataTime .

Exemples

SPSite site = new SPSite("http://contoso"); SPWeb web = new site.OpenWeb("/"); MetadataDefaults defaults = MetadataDefaults("/Documents", web); SPFolder folder = web.GetFolder("/Documents/AdventureWorks"); defaults.SetFieldDefault(folder, "Title", "AdventureWorks Document"); defaults.Update();