IStructureLibrary Interface

This interface is implemented by a Structure Library.

Declaration

interface IStructureLibrary {
    // Properties
    ${autoRecompile}: boolean;

    // Methods
    ${saveAll}(): void;
    ${recompile}(): void;
    ${openStructureFolder}(filename: string): void;
    ${newFile}(format: ${StructureFormat}): ${ISourceFile};
    ${addFile}(filename: string): void;
    ${addFiles}(files: string[]): void;
    ${openFile}(filename: string, position?: ${ITextPosition}): ${ISourceFile};
    ${removeFile}(filename: string): void;
    ${findFileByType}(typename: string): string;
    ${getFiles}(extension: string): string[];
}

// This interface is not available in managed environment

// This interface is not available in native environment

IStructureLibrary Properties

autoRecompile

autoRecompile: boolean;

// This property is not available in managed environment

// This property is not available in native environment

Auto recompile source files if changed.

IStructureLibrary Methods

saveAll

saveAll(): void;

// This method is not available in managed environment

// This method is not available in native environment

Save all opened structure definition files.

recompile

recompile(): void;

// This method is not available in managed environment

// This method is not available in native environment

Compile all structure definition files.

openStructureFolder

openStructureFolder(filename: string): void;

// This method is not available in managed environment

// This method is not available in native environment

filename: Path to the structure definition file.

Shows structure definition file in Explorer.

newFile

newFile(format: ${StructureFormat}): ${ISourceFile};

// This method is not available in managed environment

// This method is not available in native environment

format: File format.

A reference to created and opened source file.

Create new structure definition file in a given format and open it for editing.

addFile

addFile(filename: string): void;

// This method is not available in managed environment

// This method is not available in native environment

filename: Full path to a structure definition file.

Add a file to the structure library.

addFiles

addFiles(files: string[]): void;

// This method is not available in managed environment

// This method is not available in native environment

files: Array of file paths to add to the library.

Add files to the structure library.

openFile

openFile(filename: string, position?: ${ITextPosition}): ${ISourceFile};

// This method is not available in managed environment

// This method is not available in native environment

filename: Full path to a structure definition file.
position: Optional cursor position.

A reference to an opened structure definition file.

Open a given file for editing.

removeFile

removeFile(filename: string): void;

// This method is not available in managed environment

// This method is not available in native environment

filename: Full path to Structure definition file to remove.

Remove a file from the structure library.

findFileByType

findFileByType(typename: string): string;

// This method is not available in managed environment

// This method is not available in native environment

typename: Type name.

A full path to a structure definition file or null if the type is not found.

Find a structure definition file that has declaration for a given type.

getFiles

getFiles(extension: string): string[];

// This method is not available in managed environment

// This method is not available in native environment

extension: A file name extension to match.

A (possibly empty) list of file paths.

Returns a list of structure definition files from the library that match a given extension.

ISourceFile StructureFormat ITextPosition