Método Add

Crea una nueva propiedad de documento personalizada. Devuelve un objetoDocumentProperty.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.

Sintaxis

object.Add(name, linkToContent, type, value, linkSource)

object

Requerido. El objeto del conjunto DocumentProperties personalizado.

name

Requerido. Nombre de la propiedad.

linkToContent

Requerido. Especifica si la propiedad está vinculada con el contenido del documento contenedor. Si es True, el argumento linkSource será necesario. Si es False, el argumento value será necesario.

type

Requerido. El tipo de datos de la propiedad (offPropertyTypeBoolean, offPropertyTypeDate, offPropertyTypeFloat, offPropertyTypeString o offPropertyTypeNumber).

value

Opcional. El valor de la propiedad si no está vinculada con el contenido del documento contenedor. Si es posible, se convierte el valor para que coincida con el tipo de datos especificado con el argumento type; de lo contrario, se producirá un error. Si linkToContent es True, se omitirá este argumento y la nueva propiedad de documento tendrá un valor predeterminado hasta que los valores de la propiedad vinculada sean actualizados por la aplicación contenedora (hecho que se produce, normalmente, al guardar el documento).

linkSource

Opcional. Se omite si linkToContent es False. El origen de la propiedad vinculada. La aplicación contenedora determina los tipos de vinculación de origen permitida. Si desea más información, haga clic en “Detalles”, al principio de este tema.

Observaciones

No se puede usar este método con el conjunto de propiedades incorporadas.


Ejemplo del método Add

En este ejemplo se añade una nueva propiedad de documento personalizada. Deberá pasar el conjunto DocumentProperties personalizado al procedimiento.

Sub AddCustomProperty(dp As DocumentProperties)

    dp.Add name:="Completo", linkToContent:=False, _

        type:=offPropertyTypeBoolean, value:=False

End Sub


Propiedad Count

Devuelve el número de propiedades de documento del conjunto DocumentProperties. De sólo lectura.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.


Ejemplo de la propiedad Count

En este ejemplo se muestra el número de propiedades de documento de un conjunto. Deberá pasar un conjunto DocumentProperties al procedimiento.

Sub CountDocumentProperties(dp As DocumentProperties)

    MsgBox "Hay " & dp.Count & " propiedades en el conjunto."

End Sub


Método Delete

Elimina una propiedad de documento personalizada (no puede eliminar una propiedad de documento incorporada).

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.


Ejemplo del método Delete Example
Ejemplo del método Delete

En este ejemplo se elimina una propiedad de documento personalizada. Deberá pasar un objeto DocumentProperty al procedimiento.

Sub DeleteCustomDocumentProperty(dp As DocumentProperty)

    dp.Delete

End Sub


Objeto del conjunto DocumentProperties
Objeto de conjunto DocumentProperties

Representa un conjunto de propiedades de documento. Cada propiedad está representada por un objeto DocumentProperty.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.

Utilice la propiedad BuiltinDocumentProperties para devolver el conjunto de propiedades de documento incorporadas, y use la propiedad CustomDocumentProperties para devolver el conjunto de propiedades de documento personalizadas. Si desea más información acerca de cómo devolver las propiedades de documento de una aplicación contenedora, haga clic en “Detalles”, al principio de este tema.

Utilice el método Add para crear una nueva propiedad de documento personalizada y agréguela al conjunto (no podrá creara una propiedad de documento incorporada).


Objeto DocumentProperty

Representa una sola propiedad de documento. El objeto DocumentProperty es un miembro del conjunto DocumentProperties.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.

Utilice la propiedad BuiltinDocumentProperties para devolver el conjunto de propiedades de documento incorporadas, y utilice la propiedad CustomDocumentProperties para devolver el conjunto de propiedades de documento personalizadas. Utilice el método Item para devolver un solo miembro del conjunto. Si desea más información acerca de cómo devolver propiedades de documentos de una aplicación contenedora, haga clic en “Detalles”, al principio de este tema.


Método Item

Método de acceso. Devuelve un solo objeto DocumentProperty del conjunto de propiedades de documento.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.

Observaciones

Como el método Item es el predeterminado para el objeto del conjunto DocumentProperties, estos enunciados son idénticos.

CustomDocumentProperties.Item(1)

CustomDocumentProperties(1)

Podrá hacer referencia a las propiedades de documento por valor de índice o por nombre. La siguiente lista muestra los nombres de propiedades de documentos incorporadas disponibles:

Title, Subject, Author, Keywords, Comments, Template, Last Author, Revision Number, Application Name, Last Print Date, Creation Date, Last Save Time, Total Editing Time, Number of Pages, Number of Words, Number of Characters, Security, Category, Format, Manager, Company, Number of Bytes, Number of Lines, Number of Paragraphs, Number of Slides, Number of Notes, Number of Hidden Slides, Number of Multimedia Clips

Las aplicaciones contenedoras no son necesarias para definir valores  para todas las propiedades de documentos incorporadas. Si las aplicación no define un valor para una de las propiedades de documento incorporadas, se producirá un error al leer la propiedad Value para esa propiedad de documento.


Ejemplo del método Item

En este ejemplo se muestran los nombres de las propiedades de documento de un conjunto. Deberá pasar un conjunto DocumentProperties al procedimiento.

Sub DisplayPropertyNames(dp As DocumentProperties)

    Dim i As Integer

    For i = 1 To dp.Count

        MsgBox dp.Item(i).Name

    Next

End Sub


Propiedad LinkToContent

True si el valor de una propiedad de documento personalizada está vinculado con el contenido del documento contenedor. False si el valor es estático. De lectura-escritura.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.

Observaciones

Esta propiedad sólo se aplica a propiedades de documento personalizadas. Para propiedades incorporadas, esta propiedad será siempre False.

Utilice la propiedad LinkSource para establecer el origen de la propiedad vinculada. Al establecer la propiedad LinkSource se establece la propiedad LinkToContent en True.

Si desea más información acerca de cómo establecer esta propiedad en una aplicación contenedora, haga clic en “Detalles”, al principio de este tema.


Ejemplo de la propiedad LinkToContent

En este ejemplo se muestra el estado vinculado de una propiedad de documento personalizada. Deberá pasar un objeto DocumentProperty al procedimiento.

Sub DisplayLinkStatus(dp As DocumentProperty)

    Dim stat As String, tf As String

    If dp.LinkToContent Then

        tf = ""

    Else

        tf = "no "

    End If

    stat = "Esta propiedad " & tf & "está vinculada"

    If dp.LinkToContent Then

        stat = stat + Chr(13) & "El origen del vínculo es " & dp.LinkSource

    End If

    MsgBox stat

End Sub


Propiedad LinkSource

Devuelve o establece el origen de una propiedad de documento personalizada vinculada. De lectura-escritura.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.

Observaciones

La aplicación contenedoras es la que define el origen de un vínculo. Si desea más información acerca de orígenes de vínculos, haga clic en “Detalles”, al principio de este tema.

Esta propiedad no puede utilizarse con propiedades de documento incorporadas.

Al establecer la propiedad LinkSource, se establece la propiedad LinkToContent en True.


Ejemplo de la propiedad LinkSource

En este ejemplo se muestra el estado vinculado de una propiedad de documento personalizada. Deberá pasar un objeto DocumentProperty al procedimiento.

Sub DisplayLinkStatus(dp As DocumentProperty)

    Dim stat As String, tf As String

    If dp.LinkToContent Then

        tf = ""

    Else

        tf = "no "

    End If

    stat = "Esta propiedad " & tf & "está vinculada"

    If dp.LinkToContent Then

        stat = stat + Chr(13) & "El origen del vínculo es " & dp.LinkSource

    End If

    MsgBox stat

End Sub


Propiedad Name

Devuelve o establece el nombre de la propiedad del documento. De sólo lectura para propiedades de documento incorporadas; de lectura-escritura para propiedades de documento personalizadas.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.

Para consultar una lista de los nombres de propiedades de documento válidas, vea el método Item.


Ejemplo de la propiedad Name

En este ejemplo se muestra el nombre, el tipo y el valor de una propiedad de documento. Deberá pasar un objeto DocumentProperty al procedimiento.

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "tipo = " & dp.Type & Chr(13) & _

        "nombre = " & dp.Name

End Sub


Propiedad Parent

Método de acceo. Devuelve el objeto maestro del objeto especificado. De sólo lectura.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.


Ejemplo de la propiedad Parent

En este ejemplo se muestra el nombre del elemento maestro de una propiedad de documento. Deberá pasar un objeto DocumentProperty al procedimiento.

Sub DisplayParent(dp as DocumentProperty)

MsgBox dp.Parent.Name

End Sub


Propiedad Type

Devuelve o establece el tipo de propiedad del documento (offPropertyTypeBoolean, offPropertyTypeDate, offPropertyTypeFloat, offPropertyTypeNumber o offPropertyTypeString). De sólo-lectura para propiedades de documento incorporadas; de lectura-escritura para propiedades de documento personalizadas.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.


Ejemplo de la propiedad Type

En este ejemplo se muestra el nombre, el tipo y el valor de una propiedad de documento. Deberá pasar un objeto DocumentProperty al procedimiento.

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "tipo = " & dp.Type & Chr(13) & _

        "nombre = " & dp.Name

End Sub


Propiedad Value

Devuelve o establece el valor de la propiedad del documento. De lectura-escritura.

Para usar esta propiedad, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas.

Observaciones

Si la aplicación no define un valor para unas de las propiedades de documento incorporadas, se producirá un error al leer la propiedad Value para la propiedad del documento.


Ejemplo de la propiedad Value

En este ejemplo se muestra el nombre, el tipo y el valor de una propiedad de documento. Deberá pasar un objeto DocumentProperty al procedimiento.

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "valor = " & dp.Value & Chr(13) & _

        "tipo = " & dp.Type & Chr(13) & _

        "nombre = " & dp.Name

End Sub


Uso de la Biblioteca de objetos de Microsoft Office 95

Cuando utilice propiedades de documento personalizadas o incorporadas de Visual Basic, deberá establecer una referencia con la Biblioteca de objetos de Microsoft Office 95 usando el comando Referencias del menú Herramientas. Active la casilla que está junto al nombre de la biblioteca de objetos en el cuadro de diálogo Referencias.

Esta biblioteca de objetos contiene definiciones de objetos, propiedades, métodos y constantes de Visual Basic que se emplean para manipular propiedades de documento. Puede usar propiedades de documento en Visual Basic sin hacer referencia a la Biblioteca de objetos de Microsoft Office 95, pero no podrá usar constantes con nombre, verificar la sintaxis, declarar variables de objetos del tipo DocumentProperty o DocumentProperties, ni usar el Examinador de objetos ni la Ayuda contextual.