マクロリファレンス:Selection インターフェイスのソースを表示

== メソッド ==


=== ChangeCase メソッド ===
選択したテキストの大文字と小文字を変更します。

;構文
<source lang="javascript">
function ChangeCase(
    Flags : int
)
</source>

;パラメータ
Flags
{| class="wikitable"
| meCaseLowerCase || 大文字を小文字に変換します。
|-
| meCaseUpperCase || 小文字を大文字に変換します。
|}


=== ChangeWidth メソッド ===
選択したテキストの全角文字と半角文字を変更します。

;構文
<source lang="javascript">
function ChangeWidth(
    Flags : int
)
</source>

;パラメータ
Flags
{| class="wikitable"
| meWidthFullWidth || 半角文字を全角文字に変換します。
|-
| meWidthHalfWidth || 全角文字を半角文字に変換します。
|}


=== CharLeft メソッド ===
カーソルを指定の文字数分左に移動します。

;構文
<source lang="javascript">
function CharLeft(
    Extend : boolean,
    Count : int
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Count
*省略可能です。左に移動する文字数。既定値は 1 です。


=== CharRight メソッド ===
カーソルを指定の文字数分右に移動します。

;構文
<source lang="javascript">
function CharRight(
    Extend : boolean,
    Count : int
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Count
*省略可能です。右に移動する文字数。既定値は 1 です。


=== ClearBookmark メソッド ===
カーソル行のブックマークを消去します。

;構文
<source lang="javascript">
function ClearBookmark()
</source>


=== Collapse メソッド ===
選択範囲を解除します。

;構文
<source lang="javascript">
function Collapse(
    Flags : int
)
</source>

;パラメータ
Flags
{| class="wikitable"
| meCollapseStart || 選択範囲の開始位置に向けて選択範囲を解除します。
|-
| meCollapseEnd || 選択範囲の終了位置に向けて選択範囲を解除します。
|}


=== Copy メソッド ===
選択したテキストをクリップボードにコピーします。

;構文

<source lang="javascript">
function Copy()
</source>


=== CopyLink メソッド ===
カーソル位置のURLをクリップボードにコピーします。

;構文
<source lang="javascript">
function CopyLink()
</source>


=== Cut メソッド ===
選択したテキストをクリップボードにコピーし、元の位置からそのテキストを削除します。

;構文
<source lang="javascript">
function Cut()
</source>


=== Delete メソッド ===
選択したテキストを削除します。

;構文
<source lang="javascript">
function Delete(
    Count : int
)
</source>

;パラメータ
Count
*省略可能です。削除する文字数。


=== DeleteLeft メソッド ===
カーソル位置の左側にある文字を指定した文字数分削除します。

;構文
<source lang="javascript">
function DeleteLeft(
    Count : int
)
</source>

;パラメータ
Count
*省略可能です。削除する文字数。


=== DestructiveInsert メソッド ===
テキストを挿入します。既存のテキストは上書きされます。

;構文
<source lang="javascript">
function DestructiveInsert(
    Text : String
)
</source>

;パラメータ
Text
*必ず指定します。挿入するテキスト。


=== DuplicateLine メソッド ===
現在の行を複製します。

;構文
<source lang="javascript">
function DuplicateLine()
</source>


=== EndOfDocument メソッド ===
カーソルを文書の末尾に移動します。

;構文
<source lang="javascript">
function EndOfDocument(
    Extend : boolean
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。


=== EndOfLine メソッド ===
カーソルを現在の行の末尾に移動します。

;構文
<source lang="javascript">
function EndOfLine(
    Extend : boolean,
    Flags : int
)
</source>

;パラメータ
Extend
*略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== Find メソッド ===
指定のパターンを検索します。

;構文
<source lang="javascript">
function Find(
    Pattern : String,
    Flags : int
) : int
</source>

;パラメータ
Pattern
*必ず指定します。検索する文字列。
Flags
{| class="wikitable"
| meFindNext || カーソル位置から次を検索します。
|-
| meFindPrevious || カーソル位置から前を検索します。
|-
| meFindReplaceCase || 検索する単語の大文字と小文字を区別します。
|-
| meFindReplaceOnlyWord || 完全に一致する単語を検索します。
|-
| meFindAround || 文書の末尾まで検索したら先頭から検索を開始します。
|-
| meFindReplaceRegExp || 正規表現で検索します。
|}


=== FindRepeat メソッド ===
前回検索した文字列を検索します。

;構文
<source lang="javascript">
function FindRepeat(
    Flags : int
)
</source>

;パラメータ
Flags
{| class="wikitable"
| meFindNext || カーソル位置から次を検索します。
|-
| meFindPrevious || カーソル位置から前を検索します。
|-
| meFindRepeatWord || 選択範囲が空の場合はカーソル位置の単語を検索します。
|}


=== Format メソッド ===
選択範囲の折り返し位置に改行を挿入または削除します。

;構文
<source lang="javascript">
function Format(
    Flags : int
)
</source>

;パラメータ
Flags
{| class="wikitable"
| meFormatInsertNL || 折り返し位置に改行を挿入します。
|-
| meFormatDeleteNL || 折り返し位置の改行を削除します。
|-
| meFormatSplitLines || 折り返し位置に改行を挿入して行末の空白を削除します。
|-
| meFormatJoinLines || 折り返し位置の改行を削除して行末に空白を挿入します。
|}


=== GetActivePointX メソッド ===
カーソル位置の桁数を取得します。

;構文
<source lang="javascript">
function GetActivePointX(
    Flags : int
) : int
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== GetActivePointY メソッド ===
カーソル位置の行数を取得します。

;構文
<source lang="javascript">
function GetActivePointY(
    Flags : int
) : int
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== GetActivePos メソッド ===
カーソル位置を取得します。

;構文
<source lang="javascript">
function GetActivePos() : int
</source>


=== GetAnchorPointX メソッド ===
選択範囲の開始位置の桁数を取得します。

;構文
<source lang="javascript">
function GetAnchorPointX(
    Flags : int
) : int
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== GetAnchorPointY メソッド ===
選択範囲の開始位置の行数を取得します。

;構文
<source lang="javascript">
function GetAnchorPointY(
    Flags : int
) : int
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== GetAnchorPos メソッド ===
選択範囲の開始位置を取得します。

;構文
<source lang="javascript">
function GetAnchorPos() : int
</source>


=== GetBottomPointX メソッド ===
選択範囲の最後の位置の桁数を取得します。

;構文
<source lang="javascript">
function GetBottomPointX(
    Flags : int
) : int
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== GetBottomPointY メソッド ===
選択範囲の最後の位置の行数を取得します。

;構文
<source lang="javascript">
function GetBottomPointY(
    Flags : int
) : int
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== GetTopPointX メソッド ===
選択範囲の最初の位置の桁数を取得します。

;構文
<source lang="javascript">
function GetTopPointX(
    Flags : int
) : int
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== GetTopPointY メソッド ===
選択範囲の最初の位置の行数を取得します。

;構文
<source lang="javascript">
function GetTopPointY(
    Flags : int
) : int
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== Indent メソッド ===
選択した行を指定したインデントレベルでインデントします。

;構文
<source lang="javascript">
function Indent(
    Count : int
)
</source>

;パラメータ
Count
*省略可能です。インデントする表示列の数。既定値は 1 です。


=== InsertDate メソッド ===
日付と時刻をカーソル位置に挿入します。

;構文
<source lang="javascript">
function InsertDate(
    Flags : int
)
</source>

;パラメータ
Flags
{| class="wikitable"
| meDateTimeDate || 時刻、日付を挿入します。
|-
| meDateDateTime || 日付、時刻を挿入します。
|}


=== InsertFromFile メソッド ===
指定したファイルの内容をカーソル位置に挿入します。

;構文
<source lang="javascript">
function InsertFromFile(
    File : String,
    Encoding : int
)
</source>

;パラメータ
File
*必ず指定します。カーソル位置に挿入するファイル名。
Encoding
*必ず指定します。開くファイルのエンコード。

{| class="wikitable"
|  meEncodingNone || 自動選択
|-
|  meEncodingUTF16LE || Unicode (UTF-16)
|-
|  meEncodingUTF16BE || Unicode (UTF-16, Big-Endian)
|-
|  meEncodingUTF8WithSignature || Unicode (UTF-8, BOM有)
|-
|  meEncodingUTF8WithoutSignature || Unicode (UTF-8, BOM無)
|-
|  meEncodingUTF7 || Unicode (UTF-7)
|-
|  meEncodingArabic || アラビア言語 (Windows)
|-
|  meEncodingBaltic || バルト言語 (Windows)
|-
|  meEncodingCentralEuropean || 中央ヨーロッパ言語 (Windows)
|-
|  meEncodingChineseSimplified || 簡体字中国語 (GB2312)
|-
|  meEncodingChineseTraditional || 繁体字中国語 (Big5)
|-
|  meEncodingCyrillic || キリル言語 (Windows)
|-
|  meEncodingGreek || ギリシャ語 (Windows)
|-
|  meEncodingHebrew || ヘブライ語 (Windows)
|-
|  meEncodingEUC || 日本語 (EUC)
|-
|  meEncodingJIS || 日本語 (JIS)
|-
|  meEncodingShiftJIS || 日本語 (シフト JIS)
|-
|  meEncodingKorean || 韓国語
|-
|  meEncodingThai || タイ語 (Windows)
|-
|  meEncodingTurkish || トルコ語 (Windows)
|-
|  meEncodingVietnamese || ベトナム語 (Windows)
|-
|  meEncodingWesternEuropean || 西ヨーロッパ言語 (Windows)
|}


=== LineDown メソッド ===
カーソル位置を指定した行数分、下に移動します。

;構文
<source lang="javascript">
function LineDown(
    Extend : boolean,
    Count : int
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Count
*省略可能です。左に移動する文字数。既定値は 1 です。


=== LineOpen メソッド ===
カーソル位置の行間に改行を挿入します。

;構文
<source lang="javascript">
function LineDown(
    Above : boolean
)
</source>

;パラメータ
Above
*省略可能です。true を指定すると上に改行を挿入します。既定値は false です。


=== LineUp メソッド ===
カーソル位置を指定した行数分、上に移動します。

;構文
<source lang="javascript">
function LineUp(
    Extend : boolean,
    Count : int
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Count
*省略可能です。左に移動する文字数。既定値は 1 です。


=== NewLine メソッド ===
カーソル位置に改行を挿入します。

;構文
<source lang="javascript">
function NewLine(
    Count : int
)
</source>

;パラメータ
Count
*省略可能です。挿入する改行の数。既定値は 1 です。


=== NextBookmark メソッド ===
文書内の次のブックマークの位置に移動します。

;構文
<source lang="javascript">
function NextBookmark() : boolean
</source>


=== OpenLink メソッド ===
カーソル位置のURLを既定のブラウザで開きます。

;構文
<source lang="javascript">
function OpenLink()
</source>


=== PageDown メソッド ===
指定したページ数分、下に移動します。

;構文
<source lang="javascript">
function PageDown(
    Extend : boolean,
    Count : int
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Count
*省略可能です。下に移動するページ数。既定値は 1 です。


=== PageUp メソッド ===
指定したページ数分、上に移動します。

;構文
<source lang="javascript">
function PageUp(
    Extend : boolean,
    Count : int
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Count
*省略可能です。上に移動するページ数。既定値は 1 です。


=== Paste メソッド ===
カーソル位置にクリップボードの内容を挿入します。

;構文
<source lang="javascript">
function Paste()
</source>


=== PreviousBookmark メソッド ===
文書内の前のブックマークの位置に移動します。

;構文
<source lang="javascript">
function PreviousBookmark() : boolean
</source>


=== Replace メソッド ===
指定したテキストを指定したテキストで置換します。

;構文
<source lang="javascript">
function Replace(
    Pattern : String,
    Replace : String,
    Flags : int
) : int
</source>

;パラメータ
Pattern
*必ず指定します。検索する文字列。
Replace
*必ず指定します。Pattern を置換する文字列。
Flags
{| class="wikitable"
| meFindReplaceCase || 検索する単語の大文字と小文字を区別します。
|-
| meFindReplaceOnlyWord || 完全に一致する単語を検索します。
|-
| meFindReplaceRegExp || 正規表現で検索します。
|-
| meReplaceSelOnly || 選択した範囲のみ置換します。
|-
| meReplaceAll || すべて置換します。
|}


=== SelectAll メソッド ===
すべて選択します。

;構文
<source lang="javascript">
function SelectAll()
</source>


=== SelectLine メソッド ===
カーソル位置の論理行を選択します。

;構文
<source lang="javascript">
function SelectLine()
</source>


=== SetActivePoint メソッド ===
カーソル位置を設定します。

;構文
<source lang="javascript">
function SetActivePoint(
    Flags : int,
    Offset : int,
    Line : int,
    Extend : boolean
)
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}
Offset
*必ず指定します。行内の文字インデックス位置で、1 から始まります。
Line
*必ず指定します。1 から始まる行番号を指定します。
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。


=== SetActivePos メソッド ===
カーソル位置を設定します。

;構文
<source lang="javascript">
function SetActivePos(
    Pos : int,
    Extend : boolean
)
</source>

;パラメータ
Pos
*必ず指定します。文字インデックス位置で、0 から始まります。
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。


=== SetAnchorPoint メソッド ===
選択範囲の開始位置を設定します。

;構文
<source lang="javascript">
function SetAnchorPoint(
    Flags : int,
    Offset : int,
    Line : int
)
</source>

;パラメータ
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}
Offset
*必ず指定します。行内の文字インデックス位置で、1 から始まります。
Line
*必ず指定します。1 から始まる行番号を指定します。


=== SetAnchorPos メソッド ===
選択範囲の開始位置を設定します。

;構文
<source lang="javascript">
function SetAnchorPos(
    Pos : int
)
</source>

;パラメータ
Pos
*必ず指定します。文字インデックス位置で、0 から始まります。


=== SetBookmark メソッド ===
カーソル行にブックマークを設定します。

;構文
<source lang="javascript">
function SetBookmark()
</source>


=== SelectWord メソッド ===
カーソル位置の単語を選択します。

;構文
<source lang="javascript">
function SelectWord()
</source>


=== StartOfDocument メソッド ===
カーソルを文書の先頭に移動します。

;構文
<source lang="javascript">
function StartOfDocument(
    Extend : boolean
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。


=== StartOfLine メソッド ===
カーソルを現在の行の先頭に移動します。

;構文
<source lang="javascript">
function StartOfLine(
    Extend : boolean,
    Flags : int
)
</source>

;パラメータ
Extend
*略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Flags
{| class="wikitable"
| mePosView || 表示座標で指定します。
|-
| mePosLogical || 論理座標で指定します。
|}


=== Tabify メソッド ===
選択範囲の空白をタブに変換します。

;構文
<source lang="javascript">
function Tabify()
</source>


=== UnIndent メソッド ===
選択した行のインデント文字を指定したインデントレベルだけ削除します。

;構文
<source lang="javascript">
function Unindent(
    Count : int
)
</source>

;パラメータ
Count
*省略可能です。インデントする表示列の数。既定値は 1 です。


=== Untabify メソッド ===
選択範囲のタブを空白に変換します。

;構文
<source lang="javascript">
function Untabify()
</source>


=== WordLeft メソッド ===
指定した単語数だけ、カーソルを左に移動します。

;構文
<source lang="javascript">
function WordLeft(
    Extend : boolean,
    Count : int
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Count
*省略可能です。左に移動する文字数。既定値は 1 です。


=== WordRight メソッド ===
指定した単語数だけ、カーソルを右に移動します。

;構文
<source lang="javascript">
function WordRight(
    Extend : boolean,
    Count : int
)
</source>

;パラメータ
Extend
*省略可能です。移動したテキストの範囲選択を解除するかどうかを指定します。
*既定値は false です。
Count
*省略可能です。左に移動する文字数。既定値は 1 です。


== プロパティ ==


=== IsEmpty プロパティ ===
選択範囲が空どうかを取得します。

;構文
<source lang="javascript">
function get IsEmpty() : boolean
</source>


=== OverwriteMode プロパティ ===
上書きモード、挿入モードを設定または取得します。


;構文
<source lang="javascript">
function get OverwriteMode() : boolean
function set OverwriteMode(value : boolean)
</source>


=== Text プロパティ ===
選択したテキストを設定または取得します。

;構文
<source lang="javascript">
function get Text() : String
function set Text(value : String)
</source>

;プロパティ値
*選択したテキストを表す文字列。