Basic Operations

<< Click to Display Table of Contents >>

RayQC > 8.0 > User Guide > Command Line Tools > PowerShell Module 

Basic Operations

Open-Checklist

Opens a checklist from the specified file.

 

Name 

Type 

Mandatory 

Description 

File

FileInfo

Yes

The file to open

 

Returns RayQCChecklist object representing the opened file. You should store a reference to the object in a variable, because other command lets require it. Once you are finished with your checklist, make sure to close it with Close-Checklist command.

 

Close-Checklist

Opens a checklist from the specified file.

 

Name 

Type 

Mandatory 

Description 

Checklist

RayQCChecklist

Yes

The checklist to be closed.

 

This command let does not return any value.

 

New-Checklist

Opens a checklist from the specified file.

 

Name 

Type 

Mandatory 

Description 

File

FileInfo

Yes

The file path where the checklist will be saved.

 

Returns RayQCChecklist object representing the created file. You should store a reference to the object in a variable, because other command lets require it. Once you are finished with your checklist, make sure to close it with Close-Checklist command.

 

Save-Checklist

Opens a checklist from the specified file.

 

Name 

Type 

Mandatory 

Description 

Checklist

RayQCChecklist

Yes

The checklist to be saved.

File

String

No

Full path to the destination file.

AsProject

Switch

No

If specified, the checklist is saved as a project (with actual values). If not, the checklist is saved as a template (stripped out of values).

 

Returns RayQCChecklist object representing the created file. You should store a reference to the object in a variable, because other command lets require it. Once you are finished with your checklist, make sure to close it with Close-Checklist command.

 

Export-Checklist

Exports a checklist to a PDF, DOCX or HTML.

 

Name 

Type 

Mandatory 

Description 

Checklist

RayQCChecklist

Yes

The source checklist project.

File

String

Yes

The full path to the output report file.

Extension

String

No

Extension of exporting file. Available formats: PDF, DOCX, HTML.

 

Returns FileInfo object representing the exported report.