Hex Editor - Binary File Editing Software for Windows
Download Hex Editor Neo Hide this button

IStructureView Interface

interface IStructureView {
    // Properties
    readonly ${view}: ${IDocumentView};
    ${displayHex}: boolean;
    ${autoRefresh}: boolean;
    ${synchronizePosition}: boolean;
    ${showTooltips}: boolean;

    // Methods
    ${bindAsync}(view: ${IDocumentView}, params: ${IBindParams}): Promise<void>;
    ${unbindAll}(): void;
    ${unbind}(view: ${IDocumentView}, index: number): void;
    ${addScheme}(name: string, overwrite: boolean): boolean;
    ${removeScheme}(name: string): void;
    ${fieldToSelection}(view: ${IDocumentView}, index: number): void;
    ${toBookmark}(view: ${IDocumentView}, index: number): void;
    ${gotoEnd}(view: ${IDocumentView}, index: number): void;
    ${gotoTypeDefinition}(view: ${IDocumentView}, index: number): void;
    ${gotoFieldDefinition}(view: ${IDocumentView}, index: number): void;
    ${gotoValue}(view: ${IDocumentView}, index: number): void;
    ${setScheme}(view: ${IDocumentView}, name: string): void;
    ${setValue}(view: ${IDocumentView}, index: number, value: string): void;
    ${copyQualifiedName}(view: ${IDocumentView}, index: number): void;
    ${copyValue}(view: ${IDocumentView}, index: number): void;
    ${copyLine}(view: ${IDocumentView}, index: number): void;
    ${copyAllAsync}(view: ${IDocumentView}): Promise<void>;
    ${copyColumnAsync}(view: ${IDocumentView}, index: number): Promise<void>;
    ${getQualifiedName}(view: ${IDocumentView}, index: number): string;
    ${getValue}(view: ${IDocumentView}, index: number): string;
    ${getLine}(view: ${IDocumentView}, index: number): string;
    ${exportToCsvAsync}(view: ${IDocumentView}, filename: string, overwrite?: boolean): Promise<void>;
    ${expandAllAsync}(view: ${IDocumentView}): Promise<number>;
    ${collapseAll}(view: ${IDocumentView}): number;
    ${expandSubtree}(view: ${IDocumentView}, index: number): number;
    ${collapseSubtree}(view: ${IDocumentView}, index: number): number;
    ${expandAsync}(view: ${IDocumentView}, index: number): Promise<number>;
    ${collapse}(view: ${IDocumentView}, index: number): number;
}

// This interface is not available in managed environment

// This interface is not available in native environment

IStructureView Properties

view

readonly view: ${IDocumentView};

// This property is not available in managed environment

// This property is not available in native environment

Holds a reference to a current editor window.

displayHex

displayHex: boolean;

// This property is not available in managed environment

// This property is not available in native environment

Displays values in hexadecimal format if true.

autoRefresh

autoRefresh: boolean;

// This property is not available in managed environment

// This property is not available in native environment

If true, bound structures will automatically be refreshed if document data is changed.

synchronizePosition

synchronizePosition: boolean;

// This property is not available in managed environment

// This property is not available in native environment

Synchronize Position between Structure Viewer and document view.

showTooltips

showTooltips: boolean;

// This property is not available in managed environment

// This property is not available in native environment

If true, displays tooltips in Structure Viewer window.

IStructureView Methods

bindAsync

bindAsync(view: ${IDocumentView}, params: ${IBindParams}): Promise<void>;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
params
Binding parameters.

Bind specified structure.

unbindAll

unbindAll(): void;

// This method is not available in managed environment

// This method is not available in native environment

Unbind all structures from from the current view.

unbind

unbind(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
Index of the item.

Unbind the structure.

addScheme

addScheme(name: string, overwrite: boolean): boolean;

// This method is not available in managed environment

// This method is not available in native environment
name
Scheme name.
overwrite
Overwrite existing scheme.

True if operation is successful.

Save a current structure binding scheme.

removeScheme

removeScheme(name: string): void;

// This method is not available in managed environment

// This method is not available in native environment
name
Scheme name.

Delete the specified scheme.

fieldToSelection

fieldToSelection(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
Field index.

Convert a given field to selection.

toBookmark

toBookmark(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
Field index.

Convert specified structure field to bookmark.

gotoEnd

gotoEnd(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
Field index.

Move cursor to the end of the given field.

gotoTypeDefinition

gotoTypeDefinition(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
Field index.

Open structure definition file with current type definition.

gotoFieldDefinition

gotoFieldDefinition(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
Field index.

Open structure definition file with current field definition.

gotoValue

gotoValue(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
Field index.

Go to offset defined by value.

setScheme

setScheme(view: ${IDocumentView}, name: string): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
name
Scheme name.

Changes the schema for the specified view.

setValue

setValue(view: ${IDocumentView}, index: number, value: string): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.
value
A string representation of the editable value; it may contain a number or an arithmetic operation.

Change the value at the selected index.

copyQualifiedName

copyQualifiedName(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

Copy field's qualified (full) name to the Clipboard.

copyValue

copyValue(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

Copy value to the Clipboard.

copyLine

copyLine(view: ${IDocumentView}, index: number): void;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

Copy entire line to Clipboard.

copyAllAsync

copyAllAsync(view: ${IDocumentView}): Promise<void>;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.

Copy whole window contents to Clipboard.

copyColumnAsync

copyColumnAsync(view: ${IDocumentView}, index: number): Promise<void>;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

Copy selected column to clipboard

getQualifiedName

getQualifiedName(view: ${IDocumentView}, index: number): string;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

Get field's qualified name as string.

getValue

getValue(view: ${IDocumentView}, index: number): string;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

Get field's value converted to string.

getLine

getLine(view: ${IDocumentView}, index: number): string;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

Get entire line's contents as string. Column values are separated by spaces.

exportToCsvAsync

exportToCsvAsync(view: ${IDocumentView}, filename: string, overwrite?: boolean): Promise<void>;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
filename
Export file name (with full path).
overwrite
Existing file will be overwritten if true

Exports the structure view contents to a CSV file.

expandAllAsync

expandAllAsync(view: ${IDocumentView}): Promise<number>;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.

The number of elements expanded as a result of the operation (a positive value).

Expands all elements and all its children for specified document view.

collapseAll

collapseAll(view: ${IDocumentView}): number;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.

The number of elements collapsed as a result of the operation (a negative value).

Collapses all expanded elements to its parents for specified document view.

expandSubtree

expandSubtree(view: ${IDocumentView}, index: number): number;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

The number of elements expanded as a result of the operation (a positive value).

Expands the element and all its children at the specified index.

collapseSubtree

collapseSubtree(view: ${IDocumentView}, index: number): number;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

The number of elements collapsed as a result of the operation (a negative value).

Collapses the element and all its children at the specified index.

expandAsync

expandAsync(view: ${IDocumentView}, index: number): Promise<number>;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

A promise that resolves to a number of child elements added as a result of the operation (a positive value).

Expands the element at the specified index.

collapse

collapse(view: ${IDocumentView}, index: number): number;

// This method is not available in managed environment

// This method is not available in native environment
view
A reference to a document view.
index
A field's index.

The number of child elements collapsed as a result of the operation (a negative value).

Collapses the element at the specified index.

IDocumentViewIBindParams