DiagramPackage class

DiagramPackage class

Represents a native metadata package in a diagram format.

Inheritance: DiagramPackage → DocumentPackage → CustomPackage → MetadataPackage

The DiagramPackage type exposes the following members:

Properties

Property Description
metadata_type Gets the metadata type.
keys Gets a collection of the metadata property names.
property_descriptors Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count Gets the number of metadata properties.
alternate_names Gets or sets the alternate names for the document. Can be updated in VDX and VSX formats only.
build_number_created Gets the full build number of the instance used to create the document.
build_number_edited Gets the build number of the instance last used to edit the document.
category Gets or sets the descriptive text for the type of drawing, such as flowchart or office layout.
This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box.
company Gets or sets the user-entered information identifying the company creating the drawing or the company the drawing is being created for.
Maximum length is 63 characters.
creator Gets or sets the person who created or last updated the file.
The maximum length is 63 characters..
description Gets or sets a descriptive text string for the document.
Use this element to store important information about the document, such as its purpose, recent changes, or pending changes.
The maximum is 191 characters.
hyperlink_base Gets or sets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram).
By default, a hyperlink path is relative to the current document unless a different path is specified in this element.
Maximum length is 256 characters.
keywords Gets or sets a text string that identifies topics or other important information about the file, such as project name, client name, or version number.
The maximum string length is 63 characters.
language Gets or sets the language of the document.
Can be updated in VSD and VSDX formats only.
manager Gets or sets a user-entered text string identifying the person in charge of the project or department.
The maximum length is 63 characters.
preview_picture Gets or sets the preview picture.
subject Gets or sets a user-defined text string that describes the contents of the document.
Maximum length is 63 characters.
template Gets or sets a string value specifying the file name of the template from which the document was created.
time_created Gets or sets a date and time value indicating when the document was created.
time_edited Gets a date and time value indicating when the document was last edited.
time_printed Gets a date and time value indicating when the document was last printed.
time_saved Gets a date and time value indicating when the document was last saved.
title Gets or sets a user-defined text string that serves as a descriptive title for the document.
Maximum length is 63 characters.

Methods

Method Description
set Adds or replaces the metadata property with the specified name.
set Adds or replaces the metadata property with the specified name.
set Adds or replaces the metadata property with the specified name.
set Adds or replaces the metadata property with the specified name.
contains Determines whether the package contains a metadata property with the specified name.
find_properties Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.
update_properties Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.
remove_properties Removes metadata properties satisfying a specification.
add_properties Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
set_properties Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.
sanitize Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.
remove Removes a writable metadata property by the specified name.
clear Removes all writable metadata properties from the package.
clear_built_in_properties Removes all built-in metadata properties.
clear_custom_properties Removes all custom metadata properties.

Remarks

Learn more | | |

Example

This code sample demonstrates how to extract built-in metadata properties from a diagram.

See Also

DiagramRootPackage class