ITextDocument interface

No description yet.

public interface ITextDocument

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
ModifiedSinceAction	bool	get; set

ModifiedSinceAction

No description yet.

bool GetModifiedSinceAction();
void SetModifiedSinceAction(bool argValue);

Type: bool · Access: read/write

Methods

Method	Returns	Description
BeginUpdate	void
ClearGraph	void
ClearMask	void
ClearSelection	void
CurrentLineNumber	int
EndUpdate	void
GetCursorPosition	void
GetLine	void
GetLineVisibility	bool
GetSelectedText	string
GetTextAtCursor	string
GetTextAtCursorEx	string
GetWideText	string
HighlightFoundRect	void
ImportEditorSettingsFromTasking	void
ImportEditorSettingsFromVisualStudio	void
IsReadOnly	bool
IsSelectedTextPresent	bool
JumpTo	void
JumpToOffset	void
LineCount	int
MarkLine	void
MarkWordRight	void
MaskBlock	void
ReceivePreferencesChanged	void
ReplaceText	void
SaveToFile	void
SelectBlock	void
SendPreferencesChanged	void
SetFocus	void
SetLine	void
TempHighlightLine	void
UpdateSyntax	void

BeginUpdate

No description yet.

void BeginUpdate();

Returns: nothing (void)

ClearGraph

No description yet.

void ClearGraph();

Returns: nothing (void)

ClearMask

No description yet.

void ClearMask();

Returns: nothing (void)

ClearSelection

No description yet.

void ClearSelection();

Returns: nothing (void)

CurrentLineNumber

No description yet.

int CurrentLineNumber();

Returns: int

EndUpdate

No description yet.

void EndUpdate();

Returns: nothing (void)

GetCursorPosition

No description yet.

void GetCursorPosition(out int argPosX, out int argPosY);

Parameter	Type	Passing
argPosX	int	out
argPosY	int	out

Returns: nothing (void)

GetLine

No description yet.

void GetLine(int argIndex, ref string argValue);

Parameter	Type	Passing
argIndex	int	value
argValue	string	ref

Returns: nothing (void)

GetLineVisibility

No description yet.

bool GetLineVisibility(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: bool

GetSelectedText

No description yet.

string GetSelectedText();

Returns: string

GetTextAtCursor

No description yet.

string GetTextAtCursor();

Returns: string

GetTextAtCursorEx

No description yet.

string GetTextAtCursorEx(TSysCharSet argExcludeDelimiters);
string GetTextAtCursorEx(ITransportSet argExcludeDelimiters);

Parameter	Type	Passing
argExcludeDelimiters	TSysCharSet	value

Returns: string

The first overload is an extension method of ITextDocumentHelper (using DXP;) with typed parameters; the second is declared by the interface.

GetWideText

No description yet.

string GetWideText();

Returns: string

HighlightFoundRect

No description yet.

void HighlightFoundRect(int argX1, int argY1, int argX2, int argY2);

Parameter	Type	Passing
argX1	int	value
argY1	int	value
argX2	int	value
argY2	int	value

Returns: nothing (void)

ImportEditorSettingsFromTasking

No description yet.

void ImportEditorSettingsFromTasking(bool argSendNotification);

Parameter	Type	Passing
argSendNotification	bool	value

Returns: nothing (void)

ImportEditorSettingsFromVisualStudio

No description yet.

void ImportEditorSettingsFromVisualStudio(bool argSendNotification);

Parameter	Type	Passing
argSendNotification	bool	value

Returns: nothing (void)

IsReadOnly

No description yet.

bool IsReadOnly();

Returns: bool

IsSelectedTextPresent

No description yet.

bool IsSelectedTextPresent();

Returns: bool

JumpTo

No description yet.

void JumpTo(int argX, int argY, bool argCentered);

Parameter	Type	Passing
argX	int	value
argY	int	value
argCentered	bool	value

Returns: nothing (void)

JumpToOffset

No description yet.

void JumpToOffset(int argOffset);

Parameter	Type	Passing
argOffset	int	value

Returns: nothing (void)

LineCount

No description yet.

int LineCount();

Returns: int

MarkLine

No description yet.

void MarkLine();

Returns: nothing (void)

MarkWordRight

No description yet.

void MarkWordRight();

Returns: nothing (void)

MaskBlock

No description yet.

void MaskBlock(int argColumn, int argLine, int argLength, int argHeight);

Parameter	Type	Passing
argColumn	int	value
argLine	int	value
argLength	int	value
argHeight	int	value

Returns: nothing (void)

ReceivePreferencesChanged

No description yet.

void ReceivePreferencesChanged();

Returns: nothing (void)

ReplaceText

No description yet.

void ReplaceText(int argX, int argY, int argLen, string argNewText);

Parameter	Type	Passing
argX	int	value
argY	int	value
argLen	int	value
argNewText	string	value

Returns: nothing (void)

SaveToFile

No description yet.

void SaveToFile(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: nothing (void)

SelectBlock

No description yet.

void SelectBlock(int argColumn, int argLine, int argLength, int argHeight);

Parameter	Type	Passing
argColumn	int	value
argLine	int	value
argLength	int	value
argHeight	int	value

Returns: nothing (void)

SendPreferencesChanged

No description yet.

void SendPreferencesChanged();

Returns: nothing (void)

SetFocus

No description yet.

void SetFocus();

Returns: nothing (void)

SetLine

No description yet.

void SetLine(int argIndex, string argValue);

Parameter	Type	Passing
argIndex	int	value
argValue	string	value

Returns: nothing (void)

TempHighlightLine

No description yet.

void TempHighlightLine(int argIndex, string argStyleName);

Parameter	Type	Passing
argIndex	int	value
argStyleName	string	value

Returns: nothing (void)

UpdateSyntax

No description yet.

void UpdateSyntax();

Returns: nothing (void)