TextSnapshot - Bron voor Adobe ActionScript® 3 (AS3 ) API

Pakket	flash.text
Klasse	public class TextSnapshot
Overerving	TextSnapshot Object

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9, Flash Lite 4

Met een object TextSnapshot kunt u statische tekst gebruiken in een filmclip. U kunt deze bijvoorbeeld gebruiken om tekst met een grotere nauwkeurigheid op te maken dan mogelijk is met dynamische tekst terwijl u de tekst nog steeds als alleen-lezen opent.

U gebruikt geen constructor om een object TextSnapshot te maken, dit object wordt geretourneerd door de eigenschapflash.display.DisplayObjectContainer.textSnapshot.

Verwante API-elementen

flash.display.DisplayObjectContainer.textSnapshot

Openbare eigenschappen

Overerfde openbare eigenschappen verbergen

Overerfde openbare eigenschappen weergeven

	Eigenschap		Gedefinieerd door
		charCount : int [alleen-lezen] Het aantal tekens in een object TextSnapshot.	TextSnapshot
		constructor : Object Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie.	Object

Openbare methoden

Overerfde openbare methoden verbergen

Overerfde openbare methoden weergeven

	Methode		Gedefinieerd door
		findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int Doorzoekt het opgegeven object TextSnapshot en retourneert de positie van de eerste gevonden textToFind op of na beginIndex.	TextSnapshot
		getSelected(beginIndex:int, endIndex:int):Boolean Retourneert een booleaanse waarde die aangeeft of een object TextSnapshot geselecteerde tekst binnen het opgegeven bereik bevat.	TextSnapshot
		getSelectedText(includeLineEndings:Boolean = false):String Retourneert een tekenreeks die alle tekens bevat die door de overeenkomende methode setSelected() zijn opgegeven.	TextSnapshot
		getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String Retourneert een tekenreeks die alle tekens bevat die door de overeenkomende parameters beginIndex en endIndex zijn opgegeven.	TextSnapshot
		getTextRunInfo(beginIndex:int, endIndex:int):Array Retourneert array van objecten die informatie over een stuk tekst bevat.	TextSnapshot
		hasOwnProperty(name:String):Boolean Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd.	Object
		hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number Hiermee kunt u bepalen welk teken binnen een object TextSnapshot zich op of bij de opgegeven x-, y-coördinaten van de filmclip met de tekst in het object TextSnapshot bevindt.	TextSnapshot
		isPrototypeOf(theClass:Object):Boolean Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven.	Object
		propertyIsEnumerable(name:String):Boolean Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in.	Object
		setSelectColor(hexColor:uint = 0xFFFF00):void Geeft de kleur op die moet worden gebruikt wanneer tekens worden gemarkeerd die met de methode setSelected() zijn geselecteerd.	TextSnapshot
		setSelected(beginIndex:int, endIndex:int, select:Boolean):void Geeft een reeks tekens in een object TextSnapshot op die moet worden geselecteerd of waarvan de selectie moet worden opgeheven.	TextSnapshot
		toLocaleString():String Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies.	Object
		toString():String Retourneert een tekenreeksrepresentatie van het opgegeven object.	Object
		valueOf():Object Retourneert de primitieve waarde van het opgegeven object.	Object

Eigenschapdetails

charCount

eigenschap

charCount:int [alleen-lezen]

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9, Flash Lite 4

Het aantal tekens in een object TextSnapshot.

Implementatie
public function get charCount():int

Verwante API-elementen

flash.text.TextSnapshot.getText()

Methodedetails

findText

()

methode

public function findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9, Flash Lite 4

Hiermee wordt het opgegeven object TextSnapshot doorzocht en wordt de positie van de eerste gevonden textToFind op of na beginIndex geretourneerd. Wanneer textToFind niet wordt gevonden, retourneert de methode -1.

Parameters

	`beginIndex:int` — Geeft het beginpunt op voor het zoeken naar de opgegeven tekst.

	`textToFind:String` — Geeft op naar welke tekst moet worden gezocht. Wanneer u een letterlijke tekenreeks in plaats van een variabele van het type String opgeeft, moet u de tekenreeks tussen aanhalingstekens plaatsen.

	`caseSensitive:Boolean` — Hiermee wordt opgegeven of de tekst met betrekking tot hoofdlettergebruik moet overeenkomen met de tekenreeks in `textToFind`.

Geretourneerde waarde

int — De op nul gebaseerde indexpositie van de eerste instantie van de opgegeven tekst of -1.

Verwante API-elementen

flash.text.TextSnapshot.getText()

getSelected

()

methode

public function getSelected(beginIndex:int, endIndex:int):Boolean

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9, Flash Lite 4

Retourneert een booleaanse waarde die aangeeft of een object TextSnapshot geselecteerde tekst binnen het opgegeven bereik bevat.

Wanneer u alle tekens wilt zoeken, geeft u een waarde 0 voor start en charCount (of een ander groot getal) voor end door. Wanneer u één teken wilt zoeken, geeft u aan de parameter end een waarde door die één groter is dan de parameter start.

Parameters

	`beginIndex:int` — Geeft de positie aan van het eerste teken dat moet worden gecontroleerd. Geldige waarden voor `beginIndex` zijn`0` tot en met `TextSnapshot.charCount - 1`. Wanneer `beginIndex` een negatieve waarde is, wordt `0` gebruikt.

	`endIndex:int` — Een waarde die één groter is dan de index van het laatste teken dat moet worden gecontroleerd. Geldige waarden voor `endIndex` zijn `0` tot en met `charCount`. Het teken dat wordt geïndexeerd door de parameter `endIndex` wordt niet opgenomen in de geëxtraheerde tekenreeks. Wanneer deze parameter wordt weggelaten, wordt `charCount` gebruikt. Wanneer de waarde kleiner dan of gelijk is aan de waarde van `beginIndex`, wordt `beginIndex + 1` gebruikt.

Geretourneerde waarde

Boolean — Een booleaanse waarde die aangeeft of tenminste één teken in het opgegeven bereik door de bijbehorende methode setSelected() is geselecteerd (true); anders false.

Verwante API-elementen

flash.text.TextSnapshot.charCount
flash.text.TextSnapshot.getText()
flash.text.TextSnapshot.getSelectedText()
flash.text.TextSnapshot.setSelected()

getSelectedText

()

methode

public function getSelectedText(includeLineEndings:Boolean = false):String

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9., Flash Lite 4

Retourneert een tekenreeks die alle tekens bevat die door de overeenkomende methode setSelected() zijn opgegeven. Wanneer geen tekens worden opgegeven (door de methode setSelected()), wordt een lege tekenreeks geretourneerd.

Wanneer u true voor includeLineEndings doorgeeft, worden nieuwe-regeltekens in de geretourneerde tekenreeks ingevoegd, waardoor de geretourneerde tekenreeks langer kan zijn dan het invoerbereik. Wanneer includeLineEndings false is of wordt weggelaten, retourneert de methode de geselecteerde tekst zonder er tekens aan toe te voegen.

Parameters

includeLineEndings:Boolean (default = false) — Een optionele booleaanse waarde waarmee wordt opgegeven of nieuwe-regeltekens waar van toepassing in de geretourneerde tekenreeks worden ingevoegd. De standaardwaarde is false.

Geretourneerde waarde

String — Een tekenreeks die alle tekens bevat die door de bijbehorende methode setSelected() zijn opgegeven.

Verwante API-elementen

flash.text.TextSnapshot.getSelected()
flash.text.TextSnapshot.setSelected()

getText

()

methode

public function getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9., Flash Lite 4

Retourneert een tekenreeks die alle tekens bevat die door de overeenkomende parameters beginIndex en endIndex zijn opgegeven. Wanneer geen tekens zijn geselecteerd, wordt er een lege tekenreeks geretourneerd.

Wanneer u alle tekens wilt retourneren, geeft u een waarde 0 voor beginIndex en charCount (of een ander groot getal) voor endIndex door. Wanneer u één teken wilt retourneren, geeft u een waarde beginIndex + 1 voor endIndex door.

Wanneer u de waarde true doorgeeft voor includeLineEndings, worden nieuwe-regeltekens waar van toepassing ingevoegd in de geretourneerde tekenreeks. In dat geval kan de geretourneerde tekenreeks langer zijn dan het invoerbereik. Wanneer includeLineEndings false is of wordt weggelaten, wordt de geselecteerde tekst geretourneerd zonder enige tekens toe te voegen.

Parameters

	`beginIndex:int` — Geeft de positie aan van het eerste teken dat moet worden opgenomen in de geretourneerde tekenreeks. Geldige waarden voor `beginIndex` zijn`0` tot en met `charCount - 1`. Wanneer `beginIndex` een negatieve waarde is, wordt `0` gebruikt.

	`endIndex:int` — Een waarde die één groter is dan de index van het laatste teken dat moet worden gecontroleerd. Geldige waarden voor `endIndex` zijn `0` tot en met `charCount`. Het teken dat wordt geïndexeerd door de parameter `endIndex` wordt niet opgenomen in de geëxtraheerde tekenreeks. Wanneer deze parameter wordt weggelaten, wordt `charCount` gebruikt. Wanneer de waarde kleiner dan of gelijk is aan de waarde van `beginIndex`, wordt `beginIndex + 1` gebruikt.

	`includeLineEndings:Boolean` (default = `false`) — Een optionele booleaanse waarde waarmee wordt opgegeven of nieuwe-regeltekens wel (`true`) of niet (`false`) in de geretourneerde tekenreeks worden ingevoegd. De standaardwaarde is `false`.

Geretourneerde waarde

String — Een tekenreeks met de tekens in het opgegeven bereik of een lege tekenreeks als in het opgegeven bereik geen tekens worden gevonden.

Verwante API-elementen

flash.text.TextSnapshot.charCount
flash.text.TextSnapshot.getSelectedText()

getTextRunInfo

()

methode

public function getTextRunInfo(beginIndex:int, endIndex:int):Array

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9, Flash Lite 4

Retourneert array van objecten die informatie over een stuk tekst bevat. Elk object komt overeen met één teken in het tekenbereik dat is opgegeven met de twee methodeparameters.

Opmerking: wanneer u de methode getTextRunInfo() op een groot tekstbereik gebruikt, kan een groot object worden geretourneerd. Adobe raadt u aan het tekstbereik te beperken met de parameters beginIndex en endIndex.

Parameters

	`beginIndex:int` — De indexwaarde van het eerste teken in een reeks tekens in een object TextSnapshot.

	`endIndex:int` — De indexwaarde van het laatste teken in een reeks tekens in een object TextSnapshot.

Geretourneerde waarde

Array — Een array van objecten waarin elk object informatie bevat over een bepaald teken in het tekenbereik dat is opgegeven door de parameters beginIndex en endIndex. Elk object bevat de volgende elf eigenschappen:

indexInRun — Een op nul gebaseerde index met gehele getallen voor het teken (ten opzichte van de gehele tekenreeks in plaats van het geselecteerde stuk tekst).
selected — Een booleaanse waarde die aangeeft of het teken is geselecteerd (true); anders false.
font — De naam van het lettertype van het teken.
color — De gecombineerde alpha- en kleurwaarde van het teken. De eerste twee hexadecimale cijfers staan voor de alpha-waarde, de overige cijfers voor de kleurwaarde.
height — De hoogte van het teken, in pixels.
matrix_a, matrix_b, matrix_c, matrix_d, matrix_tx en matrix_ty — De waarden van een matrix die de geometrische transformatie voor het teken definiëren. Normale rechtopstaande tekst bevat altijd een matrix in de vorm [1 0 0 1 x y], waarin x en y de positie van het teken binnen de bovenliggende filmclip zijn, ongeacht de hoogte van de tekst. De matrix bevindt zich in het coördinatensysteem van de bovenliggende filmclip en bevat geen transformaties die zich in die (of de bovenliggende) filmclip kunnen bevinden.
corner0x, corner0y, corner1x, corner1y, corner2x, corner2y, corner3x en corner3y — De hoeken van het selectiekader van het teken, op basis van het coördinatensysteem van de bovenliggende filmclip. Deze waarden zijn alleen beschikbaar wanneer het lettertype van het teken is ingesloten in het SWF-bestand.

Verwante API-elementen

Matrix-klasse

hitTestTextNearPos

()

methode

public function hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9., Flash Lite 4

Hiermee kunt u bepalen welk teken binnen een object TextSnapshot zich op of bij de opgegeven x- en y-coördinaten van de filmclip met de tekst in het object TextSnapshot bevindt.

Wanneer u dit weglaat of een waarde 0 voor maxDistance doorgeeft, moet de locatie die door de x- en y-coördinaten is opgegeven, binnen het selectiekader van het object TextSnapshot liggen.

Deze methode werkt alleen correct met lettertypen met metrische informatie over tekens. In het Flash-ontwerpgereedschap wordt deze informatie standaard echter niet opgenomen voor statische tekstvelden. De methode kan dan ook -1 retourneren in plaats van een indexwaarde. Wanneer u er zeker van wilt zijn dat er een indexwaarde wordt geretourneerd, kunt u het Flash-ontwerpgereedschap zo instellen dat er metrische informatie over tekens wordt opgenomen voor een lettertype. U doet dit door een dynamisch tekstveld toe te voegen dat dat lettertype gebruikt, Tekenopties te selecteren voor dat dynamische tekstveld en vervolgens op te geven dat lettertypecontouren ten minste voor één teken moeten worden ingesloten. (Het maakt niet uit welke tekens u opgeeft en of dit de tekens zijn die worden gebruikt in de statische tekstvelden.)

Parameters

	`x:Number` — Een getal dat de `x`-coördinaat vertegenwoordigt van de filmclip die de tekst bevat.

	`y:Number` — Een getal dat de `y`-coördinaat vertegenwoordigt van de filmclip die de tekst bevat.

	`maxDistance:Number` (default = `0`) — Een optioneel getal dat de maximale afstand vanaf `x` en `y` vertegenwoordigt waarbinnen naar tekst kan worden gezocht. De afstand wordt gemeten vanaf het middelpunt van elk teken. De standaardwaarde is `0`.

Geretourneerde waarde

Number — Een getal dat de indexwaarde vertegenwoordigt van het teken dat zich het dichtst bij de opgegeven x-, y-coördinaat bevindt. Retourneert -1 wanneer geen teken wordt gevonden of wanneer het lettertype geen metrische informatie over het teken bevat.

Verwante API-elementen

flash.display.DisplayObject.x
flash.display.DisplayObject.y

setSelectColor

()

methode

public function setSelectColor(hexColor:uint = 0xFFFF00):void

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9., Flash Lite 4

Geeft de kleur op die moet worden gebruikt wanneer tekens worden gemarkeerd die met de methode setSelected() zijn geselecteerd. De kleur is altijd dekkend, u kunt geen transparante waarde opgeven.

Deze methode werkt alleen correct met lettertypen met metrische informatie over tekens. In het Flash-ontwerpgereedschap wordt deze informatie standaard echter niet opgenomen voor statische tekstvelden. De methode kan dan ook -1 in plaats van een indexwaarde retourneren. Wanneer u er zeker van wilt zijn dat een indexwaarde wordt geretourneerd, kunt u het Flash-ontwerpgereedschap zo instellen dat metrische informatie over tekens wordt opgenomen voor een lettertype. U doet dit door een dynamisch tekstveld toe te voegen dat dat lettertype gebruikt, Tekenopties te selecteren voor dat dynamische tekstveld en vervolgens op te geven dat lettertypecontouren ten minste voor één teken moeten worden ingesloten. (Het maakt niet uit welke tekens u opgeeft en of dit de tekens zijn die worden gebruikt in de statische tekstvelden.)

Parameters

hexColor:uint (default = 0xFFFF00) — De kleur die wordt gebruikt voor de rand die rondom tekens wordt geplaatst die door de bijbehorende opdracht setSelected() zijn geselecteerd, uitgedrukt in hexadecimale notatie (0x RRGGBB).

Verwante API-elementen

flash.text.TextSnapshot.setSelected()

setSelected

()

methode

public function setSelected(beginIndex:int, endIndex:int, select:Boolean):void

Taalversie:

ActionScript 3.0

Runtimeversies:

AIR 1.0, Flash Player 9., Flash Lite 4

Geeft een reeks tekens in een object TextSnapshot op die moet worden geselecteerd of waarvan de selectie moet worden opgeheven. Geselecteerde tekens worden getekend met een gekleurde rechthoek op de achtergrond die overeenkomt met het selectiekader van het teken. De kleur van het selectiekader wordt gedefinieerd door setSelectColor().

Wanneer u alle tekens wilt selecteren of de selectie van alle tekens wilt opheffen, geeft u een waarde 0 voor beginIndex en charCount (of een ander groot getal) voor endIndex door. Wanneer u één teken wilt retourneren, geeft u een waarde start + 1 voor endIndex door.

Omdat tekens afzonderlijk worden gemarkeerd als geselecteerd, kunt u deze methode meerdere keren aanroepen om meerdere tekens te selecteren. Wanneer u deze methode gebruikt, wordt de selectie van andere tekens die zijn ingesteld met deze methode niet opgeheven.

De gekleurde rechthoek waarmee een selectie wordt aangegeven, wordt alleen weergegeven voor lettertypen met metrische informatie over tekens. In Flash wordt deze informatie standaard niet opgenomen voor statische tekstvelden. In sommige gevallen betekent dit dat geselecteerde tekst niet als geselecteerd wordt weergegeven op het scherm. Wanneer u er zeker van wilt zijn dat alle geselecteerde tekst ook als geselecteerd wordt weergegeven, kunt u het Flash-ontwerpgereedschap zo instellen dat metrische informatie over tekens wordt opgenomen voor een lettertype. U doet dit door een dynamisch tekstveld toe te voegen dat dat lettertype gebruikt, Tekenopties te selecteren voor dat dynamische tekstveld en vervolgens op te geven dat lettertypecontouren ten minste voor één teken moeten worden ingesloten. Het maakt niet uit welke tekens u opgeeft en of dit de tekens zijn die worden gebruikt in de betreffende statische tekstvelden.

Parameters

	`beginIndex:int` — Geeft de positie aan van het eerste teken dat moet worden geselecteerd. Geldige waarden voor `beginIndex` zijn`0` tot en met `charCount - 1`. Wanneer `beginIndex` een negatieve waarde is, wordt `0` gebruikt.

	`endIndex:int` — Een geheel getal dat één groter is dan de index van het laatste teken dat moet worden gecontroleerd. Geldige waarden voor `end` zijn `0` tot en met `charCount`. Het teken dat wordt geïndexeerd door de parameter `end` wordt niet opgenomen in de geëxtraheerde tekenreeks. Wanneer u deze parameter weglaat, wordt `TextSnapshot.charCount` gebruikt. Wanneer de waarde van `beginIndex` kleiner dan of gelijk is aan de waarde van `endIndex`, wordt `beginIndex + 1` gebruikt.

	`select:Boolean` — Een booleaanse waarde die opgeeft of de tekst moet worden geselecteerd (`true`) of dat de selectie ervan ongedaan moet worden gemaakt (`false`).

Verwante API-elementen

flash.text.TextSnapshot.charCount
flash.text.TextSnapshot.setSelectColor()

Juridische kennisgeving | Online privacybeleid

TextSnapshot - AS3

Pakkettenx

Taalelementen

Bijlagen

Pakket flash.text

charCount

findText

getSelected

getSelectedText

getText

getTextRunInfo

hitTestTextNearPos

setSelectColor

setSelected