DocumentProperties.Add(String, Boolean, Object, Object, Object) Méthode

Définition

Espace de noms:

Microsoft.Office.Core

Assembly:

office.dll

Cette méthode crée une propriété de document personnalisée.

public Microsoft.Office.Core.DocumentProperty Add (string Name, bool LinkToContent, object Type, object Value, object LinkSource);

abstract member Add : string * bool * obj * obj * obj -> Microsoft.Office.Core.DocumentProperty

Public Function Add (Name As String, LinkToContent As Boolean, Optional Type As Object, Optional Value As Object, Optional LinkSource As Object) As DocumentProperty

Paramètres

Name

String

Argument de type String obligatoire. Nom de la propriété.

LinkToContent

Boolean

Boolean obligatoire. Indique si la propriété est liée au contenu du document conteneur ou non. Si cet argument a la valeur True, l’argument LinkSource est obligatoire ; s’il est False, l’argument valeur est obligatoire.

Type

Object

Objet facultatif. Type de données de la propriété. Il peut s’agir de l’une des constantes suivantes MsoDocProperties : msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat, msoPropertyTypeNumber ou msoPropertyTypeString.

Value

Object

Objet facultatif. Valeur de la propriété, si elle n’est pas liée au contenu du document conteneur. La valeur est convertie pour correspondre au type de données spécifié par l’argument type. S’il ne peut pas être converti, une erreur se produit. Si LinkToContent a la valeur True, l’argument Value est ignoré et la nouvelle propriété de document reçoit une valeur par défaut jusqu’à ce que les valeurs de propriété liées soient mises à jour par l’application conteneur (généralement lorsque le document est enregistré).

LinkSource

Object

Objet facultatif. Ignoré si LinkToContent a la valeur False. Source de la propriété liée. Les types de liens utilisables sont déterminés par l'application conteneur.

Retours

DocumentProperty

Remarques

Si vous ajoutez une propriété de document personnalisée à la DocumentProperties collection liée à une valeur donnée dans un document Microsoft Office, vous devez enregistrer le document pour voir la modification apportée à l’objet DocumentProperty .

Elle ne peut s'appliquer que sur la collection DocumentProperties personnalisée.