NanoXLSX.Core 3.0.0-rc.3
Loading...
Searching...
No Matches
NanoXLSX.Metadata Class Reference

Class representing the metadata of a workbook. More...

Public Member Functions

 Metadata ()
 Default constructor.

Static Public Member Functions

static string ParseVersion (int major, int minor, int build, int revision)
 Method to parse a common version (major.minor.revision.build) into the compatible format (major.minor). The minimum value is 0.0 and the maximum value is 99999.99999
The minor, revision and build number are joined if possible. If the number is too long, the additional characters will be removed from the right side down to five characters (e.g. 785563 will be 78556).

Static Public Attributes

const string DefaultApplicationName = "NanoXLSX"
 Default application name, if not otherwise specified.

Properties

static string DefaultApplicationVersion [get]
 Default application version, if not otherwise specified.
string Application [get, set]
 Gets or sets the application which created the workbook. Default is NanoXLSX.
string ApplicationVersion [get, set]
 Gets or sets the version of the creation application. Default is the library version of NanoXLSX. Use the format xxxxx.yyyyy (e.g. 1.0 or 55.9875) in case of a custom value.
string Category [get, set]
 Gets or sets the category of the document. There are no predefined values or restrictions about the content of this field.
string Company [get, set]
 Gets or sets the company owning the document. This value is for organizational purpose. Add more than one manager by using the semicolon (;) between the words.
string ContentStatus [get, set]
 Gets or sets the status of the document. There are no predefined values or restrictions about the content of this field.
string Creator [get, set]
 Gets or sets the creator of the workbook. Add more than one creator by using the semicolon (;) between the authors.
string Description [get, set]
 Gets or sets the description of the document or comment about it.
string HyperlinkBase [get, set]
 Gets or sets the hyperlink base of the document.
string Keywords [get, set]
 Gets or sets the keywords of the workbook. Separate particular keywords with semicolons (;).
string Manager [get, set]
 Gets or sets the responsible manager of the document. This value is for organizational purpose.
string Subject [get, set]
 Gets or sets the subject of the workbook.
string Title [get, set]
 Gets or sets the title of the workbook.

Detailed Description

Class representing the metadata of a workbook.

Definition at line 18 of file Metadata.cs.

Constructor & Destructor Documentation

◆ Metadata()

NanoXLSX.Metadata.Metadata ( )

Default constructor.

Definition at line 105 of file Metadata.cs.

Member Function Documentation

◆ ParseVersion()

string NanoXLSX.Metadata.ParseVersion ( int major,
int minor,
int build,
int revision )
static

Method to parse a common version (major.minor.revision.build) into the compatible format (major.minor). The minimum value is 0.0 and the maximum value is 99999.99999
The minor, revision and build number are joined if possible. If the number is too long, the additional characters will be removed from the right side down to five characters (e.g. 785563 will be 78556).

Parameters
majorMajor number from 0 to 99999
minorMinor number
buildBuild number
revisionRevision number
Returns
Formatted version number (e.g. 1.0 or 55.987)
Exceptions
NanoXLSX.Exceptions.FormatExceptionThrows a FormatException if the major number is too long or one of the numbers is negative

Definition at line 151 of file Metadata.cs.

Member Data Documentation

◆ DefaultApplicationName

const string NanoXLSX.Metadata.DefaultApplicationName = "NanoXLSX"
static

Default application name, if not otherwise specified.

Definition at line 25 of file Metadata.cs.

Property Documentation

◆ Application

string NanoXLSX.Metadata.Application
getset

Gets or sets the application which created the workbook. Default is NanoXLSX.

Definition at line 45 of file Metadata.cs.

◆ ApplicationVersion

string NanoXLSX.Metadata.ApplicationVersion
getset

Gets or sets the version of the creation application. Default is the library version of NanoXLSX. Use the format xxxxx.yyyyy (e.g. 1.0 or 55.9875) in case of a custom value.

Remarks
Allowed values are null, empty and fractions from 0.0 to 99999.99999 (max. number of digits before and after the period is 5)

Definition at line 50 of file Metadata.cs.

◆ Category

string NanoXLSX.Metadata.Category
getset

Gets or sets the category of the document. There are no predefined values or restrictions about the content of this field.

Definition at line 62 of file Metadata.cs.

◆ Company

string NanoXLSX.Metadata.Company
getset

Gets or sets the company owning the document. This value is for organizational purpose. Add more than one manager by using the semicolon (;) between the words.

Definition at line 66 of file Metadata.cs.

◆ ContentStatus

string NanoXLSX.Metadata.ContentStatus
getset

Gets or sets the status of the document. There are no predefined values or restrictions about the content of this field.

Definition at line 70 of file Metadata.cs.

◆ Creator

string NanoXLSX.Metadata.Creator
getset

Gets or sets the creator of the workbook. Add more than one creator by using the semicolon (;) between the authors.

Definition at line 74 of file Metadata.cs.

◆ DefaultApplicationVersion

string NanoXLSX.Metadata.DefaultApplicationVersion
staticget

Default application version, if not otherwise specified.

Definition at line 29 of file Metadata.cs.

◆ Description

string NanoXLSX.Metadata.Description
getset

Gets or sets the description of the document or comment about it.

Definition at line 78 of file Metadata.cs.

◆ HyperlinkBase

string NanoXLSX.Metadata.HyperlinkBase
getset

Gets or sets the hyperlink base of the document.

Definition at line 82 of file Metadata.cs.

◆ Keywords

string NanoXLSX.Metadata.Keywords
getset

Gets or sets the keywords of the workbook. Separate particular keywords with semicolons (;).

Definition at line 86 of file Metadata.cs.

◆ Manager

string NanoXLSX.Metadata.Manager
getset

Gets or sets the responsible manager of the document. This value is for organizational purpose.

Definition at line 90 of file Metadata.cs.

◆ Subject

string NanoXLSX.Metadata.Subject
getset

Gets or sets the subject of the workbook.

Definition at line 94 of file Metadata.cs.

◆ Title

string NanoXLSX.Metadata.Title
getset

Gets or sets the title of the workbook.

Definition at line 98 of file Metadata.cs.


The documentation for this class was generated from the following file: