ArborX

tsave

Longname: t save   Open the Documentation Legend
Released: not available 
Created: not available 
See also: tdspref tsaven tks tsavea tsavetxt tsavehtm

Summary
 Saves the current document or portions of it to a file. The only difference between the tsave and tsaven macros is how they behave when the parameters are omitted. The tsave macro will automatically save the whole document under its current file name, unless its extension is .3f (used for 3B2 template files), in which case it will behave like tsaven and invoke a dialogue box into which you may type a file name.
Example extract

The macro shown below simply saves the current document. If this is a .3f file the save document dialogue box will prompt you to enter a new name.

 tsave

Syntax (SVNNA)
tsave  default:n?  [  file:s  options:s?  ]? 
Ø:

tsave saves the current document as a .3d file unless its file extension is .3f. In this case tsave behaves like tsaven which displays the Save Document dialogue box.
default:n
0  Makes tsave default to saving the current document as a .3d file, unless a further extension parameter is specified as noted below.
1  Makes tsave default to saving the current document as a .3f file unless another extension is specified in the file parameter.
file:s

The file name under which you want to save the current document or a portion of it. The first part of file is either an optional prefix which you can specify, or the name of the entity within the file that you want to save. The second part of file is an extension, either .3d or .3f, or one of the special file suffixes listed below. Any entity saved with the special extensions can be loaded into any other document with the tload macro.

.3d  Saves the file as a normal .3d document. If the file is a 3B2 template file (.3f) the Save Document dialogue box will be invoked.
.3c  Saves named colours. Names not truncated on Windows 95/NT.
.3f  Saves the file as a 3B2 template file. This is particularly useful if you make changes to the template files supplied with 3B2, for instance to their default settings and want to carry on listing them when you open a new document.
.3h  Outputs tag header information only. This is useful when integrating 3B2 with an external program. The file contains tag headers plus complete fdb, fdp, fdd, fdpref and fde blocks.
.3o  Saves an object graphic from your document to the specified file name. The file prefix comes from the tag name of the object graphic. If this is longer than eight characters the file name is truncated.
.3p  Saves document preferences (mainly, but not exclusively those set up with the tdpref, tdslevel and tdplevel macros) to a specified file whose file prefix you specify.
.3r  Saves a raster graphic from your document. The file prefix is the tag name of the raster graphic. If this is longer than eight characters the file name is truncated.
.3s  Saves all style tags from your document to a specified file whose file prefix you specify. This can be useful for transferring all of your styles to another document.
.3t  Saves a text stream from your document. The file prefix is the tag name of the text stream. If this is longer than eight characters the file name is truncated.
.3x  Saves any entity from the current file. The type of the entity is not important (as it is with the .3t, .3o and .3r extensions). This extension can also be used to save page over/underlay layouts. The file prefix is the tag name of the entity you want to save. If this is longer than eight characters the file name is truncated.
options:s
a  Save all (normal save).
o  Overwrite an existing file without prompting, should be used together with the 'a' option. (Added in version 8.13v).
Example

The macro shown below saves the current document – test1.3d -- under a new name, but still in .3d format. The previous version of the document is not deleted or over-written. The new file will be called test2.3d, and will by default be saved in Arbortext APP's working directory, usually \3d.

 tsave "test2"
Example

This macro saves an object graphic with the tag name Object to file. The file name will be object.3o:

 tsave "object.3o"
Example

The example below saves a defined colour as a tag within document, so that the c,m,y,k can be retrieved.

 tsave "{0}PANTONE_E_2-3_CVP.3x"

If your colour name is "COLOUR_TAG" then execute the following macro:

 tsave "{0}COLOUR_TAG.3x"

This will create a text tag in your document called "COLOUR_TAG." (with trailing dot). You can examine this to get the 3B2 definition. If you want, you can change the definition to replace the existing colour by executing the following macro:

The Tag Clash dialogue box will appear on your screen. If you do not want to change this definition, delete the old colour tag first or use thewdb macro to force the Replace button when the dialogue appears.

 tload "{0}COLOUR_TAG."

Document created on 08-Feb-2003, last reviewed on 06-Sep-2005 (revision 1)