NXOpen.Gateway.BookmarkFile Class Reference

Represents operations which can be done on bookmark files. More...

Inheritance diagram for NXOpen.Gateway.BookmarkFile:

Public Member Functions
unsafe void	Delete (string pathName)
	Deletes an existing bookmark file. More...
unsafe string	Rename (string oldPathName, string newFileName, bool okToOverwriteExistingFile)
	Renames an existing bookmark file. More...
unsafe void	SaveWithDescription (string pathName, NXOpen.BasePart.BookmarkOption bookmarkOption, string description)
	Creates a bookmark file including a description. More...
unsafe void	SetDescription (string pathName, string description)
	Changes the description of an existing bookmark file. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
Tag	Tag [get]
	Returns the tag of this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Detailed Description

Represents operations which can be done on bookmark files.

To obtain an instance of this class, refer to NXOpen.Session

Created in NX10.0.0

Member Function Documentation

unsafe void NXOpen.Gateway.BookmarkFile.Delete ( string  pathName )

inline

Deletes an existing bookmark file.

Created in NX10.0.0

License requirements: None.

Parameters

pathName

Full path name of existing bookmark file to delete

unsafe string NXOpen.Gateway.BookmarkFile.Rename ( string  oldPathName, string  newFileName, bool  okToOverwriteExistingFile  )

inline

Renames an existing bookmark file.

Created in NX10.0.0

License requirements: None.

Parameters

oldPathName	Full path name of existing bookmark file.
newFileName	New name to assign to the bookmark file. This will replace the basic name in the old path name.
okToOverwriteExistingFile	Is it okay to overwrite an existing file with the same name as the old path name plus the new file name?

Returns

Full path name to the renamed bookmark file. This text string must be freed by the caller.

unsafe void NXOpen.Gateway.BookmarkFile.SaveWithDescription ( string  pathName, NXOpen.BasePart.BookmarkOption  bookmarkOption, string  description  )

inline

Creates a bookmark file including a description.

See NXOpen.BasePart.BookmarkOption for an explanation of the options which are not supported in batch mode. Also in batch mode, the description is not written to the bookmark file.

Created in NX10.0.0

License requirements: None.

Parameters

pathName	Full path name of bookmark file.
bookmarkOption	See definitions of NXOpen.BasePart.BookmarkOption
description	A text string to be stored in the bookmark file

unsafe void NXOpen.Gateway.BookmarkFile.SetDescription ( string  pathName, string  description  )

inline

Changes the description of an existing bookmark file.

Otherwise the bookmark file is unchanged.

Created in NX10.0.0

License requirements: None.

Parameters

pathName	Full path name of an existing bookmark file.
description	A text string to replace the current description in the bookmark file

Property Documentation

Tag NXOpen.Gateway.BookmarkFile.Tag

get

Returns the tag of this object.

---

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

• Gateway_BookmarkFile.cs