Show / Hide Table of Contents

Class NSDocumentPreview

Document data intended for preview purposes. Carrier object for DocumentPreview.

Syntax

Constructors

NSDocumentPreview()

Initializes a new instance of the NSDocumentPreview class.

Declaration
NSDocumentPreview

Methods

GetName()

Document data intended for preview purposes. Carrier object for DocumentPreview.

Declaration
String GetName()
Returns
Type Description
String

The documents name.

Examples
NSDocumentPreview thing;
String name = thing.GetName();

GetSize()

Document data intended for preview purposes. Carrier object for DocumentPreview.

Declaration
Integer GetSize()
Returns
Type Description
Integer

Size of the stream.

Examples
NSDocumentPreview thing;
Integer size = thing.GetSize();

GetStream()

Document data intended for preview purposes. Carrier object for DocumentPreview.

Declaration
NSStream GetStream()
Returns
Type Description
NSStream

Document data.

Examples
NSDocumentPreview thing;
NSStream stream = thing.GetStream();

GetType()

Document data intended for preview purposes. Carrier object for DocumentPreview.

Declaration
String GetType()
Returns
Type Description
String

The mimetype of the stream.

Examples
NSDocumentPreview thing;
String type = thing.GetType();

SetName(String)

Document data intended for preview purposes. Carrier object for DocumentPreview.

Declaration
Void SetName(String name)
Parameters
Type Name Description
String name

The documents name.

Returns
Type Description
Void
Examples
NSDocumentPreview thing;
String name;
thing.SetName(name);

SetSize(Integer)

Document data intended for preview purposes. Carrier object for DocumentPreview.

Declaration
Void SetSize(Integer size)
Parameters
Type Name Description
Integer size

Size of the stream.

Returns
Type Description
Void
Examples
NSDocumentPreview thing;
Integer size;
thing.SetSize(size);

SetStream(NSStream)

Document data intended for preview purposes. Carrier object for DocumentPreview.

Declaration
Void SetStream(NSStream stream)
Parameters
Type Name Description
NSStream stream

Document data.

Returns
Type Description
Void
Examples
NSDocumentPreview thing;
NSStream stream;
thing.SetStream(stream);

SetType(String)

Document data intended for preview purposes. Carrier object for DocumentPreview.

Declaration
Void SetType(String type)
Parameters
Type Name Description
String type

The mimetype of the stream.

Returns
Type Description
Void
Examples
NSDocumentPreview thing;
String type;
thing.SetType(type);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top