Click or drag to resize

IAltaxoProjectService Interface

[Missing <summary> documentation for "T:Altaxo.Main.IAltaxoProjectService"]


Namespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public interface IAltaxoProjectService : IProjectService

The IAltaxoProjectService type exposes the following members.

Properties
 NameDescription
Public propertyCurrentOpenProject 
Public propertyCurrentOpenProjectOrNull 
Public propertyCurrentProject Getter / setter for the currently open project.
(Inherited from IProjectService)
Public propertyCurrentProjectArchiveManager Gets the object that represents the storage of the current project on disk. If the current project was opened as a COM object, the value is null.
(Inherited from IProjectService)
Public propertyCurrentProjectFileName Gets the file name for the currently open project. Is null if the project has not got a file name for now.
(Inherited from IProjectService)
Public propertyProjectFileExtensions Gets all possible file extensions for acceptable project files.
(Inherited from IProjectService)
Top
Methods
 NameDescription
Public methodAskForSavingOfProject Asks the user whether or not the project should be saved, and saves it in case the user answers with yes.
(Inherited from IProjectService)
Public methodCloseDocumentViews Closes all open views for a given document.
(Inherited from IProjectService)
Public methodCloseProject Closes a project. If the project is dirty, and forceClose is false, the user is asked to save the project.
(Inherited from IProjectService)
Public methodCloseViewContent Closes the view content.
(Inherited from IProjectService)
Public methodCreateDocumentT Creates a project item, and adds it to the appropriate collection in the current project. Note that there might exist more specialized function to create a certain project item.
Public methodCreateInitialProject Creates the very first document. Used internal into the autostart command.
(Inherited from IProjectService)
Public methodCreateNewGraph Creates a new graph document and the view for this newly created graph document.
Public methodCreateNewGraph(GraphDocument) Creates a new view content for a graph document.
Public methodCreateNewGraph(String) Creates a new graph document and the view for this newly created graph document.
Public methodCreateNewGraph3D Creates a new view content for a graph document.
Public methodCreateNewGraphInFolder Creates a new graph document in a specified folder and the view for this newly created graph document.
Public methodCreateNewWorksheet Creates a new table and the view content for the newly created table.
Public methodCreateNewWorksheet(DataTable) Creates a view content for a table.
Public methodCreateNewWorksheet(DataTable, WorksheetLayout) Creates a view content for a table.
Public methodCreateNewWorksheetInFolder Creates a new table and the view content for the newly created table.
Public methodDeleteDocument This function will delete a project item and close all corresponding views.
(Inherited from IProjectService)
Public methodDeleteGraphDocument This function will delete a graph document and close all corresponding views.
Public methodDeleteTable This function will delete a data table and close the corresponding views.
Public methodDisposeProjectAndSetToNull Disposes the entire project and sets the current project to null. Attention: This function is intended to be used during application shutdown only.
(Inherited from IProjectService)
Public methodExchangeCurrentProjectArchiveManagerTemporarilyWithoutDisposing Exchanges the current project archive manager without disposing the old manager. This function is intended to be used twice in succession: 1st to temporarily exchange the current archive manager by another on, and then to change back the new archive manager with the old one.
(Inherited from IProjectService)
Public methodExecuteActionsImmediatelyBeforeRunningApplication Executes any neccessary actions immediately before running the main application. When calling this, the services and the workbench are already initialized. The method can for instance load any files that are given in the command line.
(Inherited from IProjectService)
Public methodGetMainWindowTitle Gets the title that should be shown as the main window title.
(Inherited from IProjectService)
Public methodGetOpenDocuments Gets a set of all open documents, i.e. GraphDocuments, DataTables. (Not Worksheets).
(Inherited from IProjectService)
Public methodGetProjectItemImageExporter Gets an exporter that can be used to export an image of the provided project item.
Public methodHasDocumentAnOpenView Returns true if the given document has at least one open view in the workbench.
(Inherited from IProjectService)
Public methodIsProjectFileExtension Determines whether the provided file extension is a project extension.
(Inherited from IProjectService)
Public methodOpenOrCreateGraphForGraphDocument Opens a view that shows the graph
C#
graph
. If no view for the graph can be found, a new default view is created.
Public methodOpenOrCreateViewContentForDocument Opens a view that shows the document document. If no view for the document can be found, a new default view is created.
Public methodOpenOrCreateWorksheetForTable Opens a view that shows the table
C#
table
. If no view for the table can be found, a new default view is created for the table.
Public methodOpenProject Opens a Altaxo project. If the current project is dirty, and showUserInteraction is true, the user is ask to save the current project before.
(Inherited from IProjectService)
Public methodOpenProjectFromArchive Opens a project from an archive. This function is intended for opening the project from a COM stream on a freshly started application. Thus it is assumed that no old project has to be saved before!
(Inherited from IProjectService)
Public methodRemoveGraphThis will remove the Graph from the corresponding forms collection.
Public methodRemoveGraph3DThis will remove the Graph from the corresponding forms collection.
Public methodRemoveWorksheetThis will remove the Worksheet from the corresponding forms collection.
Public methodSaveProject Saves a project under the current file name.
(Inherited from IProjectService)
Public methodSaveProject(IProjectArchive) Saves the project in the provided archive. Is intended for saving the project into a COM stream only. For regular saving into the file system, use one of the other Save.. methods.
(Inherited from IProjectService)
Public methodSaveProject(PathName) Saves the project under the given file name, using the standard archive format.
(Inherited from IProjectService)
Public methodSaveProjectAs Asks the user for a file name for the current project, and then saves the project under the given name.
(Inherited from IProjectService)
Public methodSaveProjectCopyAs This command is used if in embedded object mode. It saves the current project to a file, but don't set the current file name of the project (in project service). Furthermore, the title in the title bar is not influenced by the saving.
(Inherited from IProjectService)
Public methodShowDocumentView Shows a view for the given document.
(Inherited from IProjectService)
Public methodTryOpenProjectItemFile Tests if the provided file name to have an extension that is associated with the extension of a project item (a specific item of the project), and if it is, tries to open the project item and adds it to the current project.
(Inherited from IProjectService)
Top
Events
 NameDescription
Public eventProjectChanged Event fired after any of the following other events is fired: ProjectOpened, ProjectClosed, ProjectRenamed, and ProjectDirtyChanged.
(Inherited from IProjectService)
Public eventProjectClosed Fired when the current open project is closed.
(Inherited from IProjectService)
Public eventProjectDirtyChanged Fired when the dirty state of the project changed.
(Inherited from IProjectService)
Public eventProjectOpened Fired when a project is opened or a new empty project is created.
(Inherited from IProjectService)
Public eventProjectRenamed Fired when the current open project is renamed.
(Inherited from IProjectService)
Top
See Also