Objet Document

Disponibilité

Flash MX 2004.

Description

L’objet Document représente la scène. En d’autres termes, seuls les fichiers FLA sont considérés comme des documents. Pour renvoyer l'objet Document du document actif, utilisez fl.getDocumentDOM().

Résumé des méthodes

Vous pouvez utiliser les méthodes suivantes avec l’objet Document :

Méthode

Description

document.addDataToDocument()

Enregistre les données spécifiées avec un document.

document.addDataToSelection()

Enregistre les données spécifiées avec le ou les objets sélectionnés.

document.addFilter()

Applique un filtre aux objets sélectionnés.

document.addItem()

Ajoute à l’objet Document spécifié un élément provenant d’un document ouvert ou d’une bibliothèque.

document.addNewLine()

Ajoute un nouveau tracé entre deux points.

document.addNewOval()

Ajoute un nouvel objet Oval dans le rectangle de délimitation spécifié.

document.addNewPrimitiveOval()

Ajoute une nouvelle primitive ovale adaptée aux limites spécifiées.

document.addNewPrimitiveRectangle()

Ajoute une nouvelle primitive rectangle adaptée aux limites spécifiées.

document.addNewPublishProfile()

Ajoute un nouveau profil de publication et l’active.

document.addNewRectangle()

Ajoute un nouveau rectangle ou rectangle arrondi dans la délimitation spécifiée.

document.addNewScene()

Ajoute une nouvelle séquence (Objet Timeline) après la séquence actuellement sélectionnée, puis fait de cette nouvelle séquence la séquence sélectionnée.

document.addNewText()

Insère un nouveau champ de texte vide.

document.align()

Aligne la sélection.

document.allowScreens()

Cette méthode doit être utilisée avant la propriété document.screenOutline.

document.arrange()

Organise la sélection sur la scène.

document.breakApart()

Effectue une opération de séparation sur la sélection en cours.

document.canEditSymbol()

Indique si le menu Modifier les symboles et ses fonctionnalités sont activés.

document.canRevert()

Détermine s'il est possible d'utiliser la méthode document.revert() ou fl.revertDocument().

document.canSaveAVersion()

Détermine si une version du document spécifié peut être enregistrée sur le serveur Version Cue.

document.canTestMovie()

Détermine s'il est possible d'utiliser la méthodedocument.testMovie().

document.canTestScene()

Détermine s'il est possible d'utiliser la méthodedocument.testScene().

document.changeFilterOrder()

Change l’index du filtre dans la liste Filtres.

document.clipCopy()

Copie la sélection actuelle du document dans le Presse-papiers.

document.clipCut()

Coupe la sélection actuelle du document et la place dans le Presse-papiers.

document.clipPaste()

Colle le contenu du Presse-papiers dans le document.

document.close()

Ferme le document spécifié.

document.convertLinesToFills()

Convertit des lignes en remplissages pour les objets sélectionnés.

document.convertToSymbol()

Convertit le ou les éléments sélectionnés sur la scène en un nouveau symbole.

document.crop()

Sur la base de l’objet de dessin sélectionné qui se trouve au-dessus, recadre tous les objets de dessin de niveau inférieur.

document.deleteEnvelope()

Supprime l’enveloppe (cadre de sélection contenant un ou plusieurs objets) de l’objet sélectionné.

document.deletePublishProfile()

Supprime le profil actif, s’il existe plusieurs profils.

document.deleteScene()

Supprime la séquence actuelle (Objet Timeline) et, si cette séquence n’était pas la dernière, définit la prochaine comme l'objet Timeline actif.

document.deleteSelection()

Supprime la sélection actuelle sur la scène.

document.disableAllFilters()

Désactive tous les filtres des objets sélectionnés.

document.disableFilter()

Dans la liste Filtres, désactive le filtre spécifié.

document.disableOtherFilters()

Dans la liste Filtres, désactive tous les filtres à l’exception de celui qui se trouve à la position spécifiée.

document.distribute()

Répartit la sélection.

document.distributeToLayers()

Effectue sur la sélection actuelle une opération de répartition vers les calques ; cette méthode est l’équivalent de l’option de menu Répartir vers les calques.

document.documentHasData()

Recherche dans le document des données persistantes portant le nom spécifié.

document.duplicatePublishProfile()

Duplique le profil actuellement actif et donne le focus à ce duplicata.

document.duplicateScene()

Crée une copie de la séquence actuellement sélectionnée, en donnant à cette nouvelle séquence un nom unique et en en faisant la séquence active.

document.duplicateSelection()

Duplique la sélection sur la scène.

document.editScene()

Sélectionne la séquence spécifiée pour modification.

document.enableAllFilters()

Active tous les filtres de la liste Filtres pour le ou les objets sélectionnés.

document.enableFilter()

Active le filtre spécifié pour le ou les objets sélectionnés.

document.enterEditMode()

Bascule l’environnement de programmation dans le mode de modification spécifié par le paramètre.

document.exitEditMode()

Quitte le mode Modification de symbole et renvoie le focus au niveau supérieur suivant.

document.exportPNG()

Exporte le document dans un ou plusieurs fichiers PNG.

document.exportPublishProfile()

Exporte le profil actif dans un fichier XML.

document.exportPublishProfileString()

Renvoie une chaîne représentant le profil spécifié, au format XML.

document.exportSWF()

Exporte le document au format Flash SWF.

document.getAlignToDocument()

Récupère la valeur du bouton Sur la scène dans le panneau Aligner.

document.getBlendMode()

Renvoie une chaîne indiquant le mode de fondu pour le ou les objets sélectionnés.

document.getCustomFill()

Récupère l’objet de remplissage (Fill) de la forme sélectionnée ou, selon le paramètre, du panneau Outils et de l'inspecteur Propriétés.

document.getCustomStroke()

Renvoie l’objet trait (Stroke) de la forme sélectionnée ou, selon le paramètre, du panneau Outils et de l'inspecteur Propriétés.

document.getDataFromDocument()

Récupère la valeur des données spécifiées.

document.getElementProperty()

Récupère la propriété Element spécifiée pour la sélection.

document.getElementTextAttr()

Récupère la propriété TextAttrs spécifiée pour les objets Text sélectionnés.

document.getFilters()

Renvoie un tableau contenant la liste des filtres appliqués aux objets actuellement sélectionnés.

document.getMetadata()

Renvoie une chaîne contenant les métadonnées XML associées au document.

document.getMobileSettings()

Renvoie la chaîne transmise à document.setMobileSettings().

document.getPlayerVersion()

Renvoie une chaîne représentant la version de Flash Player ciblée pour le document spécifié.

document.getSelectionRect()

Récupère les coordonnées du rectangle de délimitation de la sélection.

document.getTextString()

Récupère le texte sélectionné.

document.getTimeline()

Récupère l'Objet Timeline dans le document.

document.getTransformationPoint()

Récupère l’emplacement du point de transformation de la sélection.

document.group()

Convertit la sélection en un groupe.

document.importFile()

Importe un fichier dans le document.

document.importPublishProfile()

Importe un profil à partir d’un fichier.

document.importPublishProfileString()

Importe une chaîne XML représentant un profil de publication et la définit en tant que profil actuel.

document.importSWF()

Importe un fichier SWF dans le document.

document.intersect()

Crée un objet de dessin Intersection à partir de tous les objets de dessin sélectionnés.

document.match()

Donne la même taille à tous les objets sélectionnés.

document.mouseClick()

Effectue un clic de souris à partir de l’outil Sélection.

document.mouseDblClk()

Effectue un double clic de souris à partir de l’outil Sélection.

document.moveSelectedBezierPointsBy()

Si la sélection contient au moins un tracé comptant au moins un point de courbe de Bézier, cette méthode déplace de la valeur spécifiée tous les points de courbe de Bézier de tous les tracés sélectionnés.

document.moveSelectionBy()

Déplace les objets sélectionnés de la distance spécifiée.

document.optimizeCurves()

Optimise le lissage de la sélection, le cas échéant en autorisant plusieurs passages pour obtenir un lissage optimal équivalent au choix de l’option Modifier > Forme > Optimiser.

document.publish()

Publie le document en fonction des paramètres de publication actuels (Fichier > Paramètres de publication) ; cette méthode est l’équivalent de l’option Fichier > Publier.

document.punch()

Sur la base de l’objet de dessin sélectionné le plus élevé, poinçonne tous les objets de dessin de niveau inférieur sélectionnés.

document.removeAllFilters()

Supprime tous les filtres du ou des objets sélectionnés.

document.removeDataFromDocument()

Supprime les données persistantes associées au document et correspondant au nom spécifié.

document.removeDataFromSelection()

Supprime les données persistantes associées à la sélection et correspondant au nom spécifié.

document.removeFilter()

Supprime le filtre spécifié de la liste Filtres pour le ou les objets sélectionnés.

document.renamePublishProfile()

Renomme le profil actuel.

document.renameScene()

Renomme la séquence sélectionnée dans le panneau Séquences.

document.reorderScene()

Place la séquence spécifiée devant une autre séquence spécifiée.

document.resetOvalObject()

Dans l'inspecteur Propriétés, définit toutes les valeurs sur les paramètres par défaut de l'objet Oval.

document.resetRectangleObject()

Dans l'inspecteur Propriétés, définit toutes les valeurs sur les paramètres par défaut de l'objet Rectangle.

document.resetTransformation()

Réinitialise la matrice de transformation ; cette méthode est l’équivalent de l’option de menu Modification > Transformer > Supprimer la transformation.

document.revert()

Restaure la dernière version enregistrée du document spécifié ; cette méthode est l’équivalent de l’option de menu Fichier > Rétablir.

document.revertToLastVersion()

Remplace la version du document spécifié par celle qui est stockée sur le serveur Version Cue et consigne les éventuelles erreurs dans le panneau Sortie.

document.rotate3DSelection()

Applique une rotation 3D à la sélection.

document.rotateSelection()

Fait pivoter la sélection du nombre de degrés spécifié.

document.save()

Enregistre le document à son emplacement par défaut ; cette méthode est l’équivalent de l’option de menu Fichier > Enregistrer.

document.saveAndCompact()

Enregistre et compresse le fichier ; cette méthode est l’équivalent de l’option de menu Fichier > Enregistrer et compresser.

document.saveAVersion()

Enregistre une version du document spécifié sur le serveur Version Cue.

document.scaleSelection()

Effectue une mise à l’échelle de la sélection de la valeur spécifiée ; cette méthode est l’équivalent de l’outil Transformation libre utilisé pour modifier l’échelle de l’objet.

document.selectAll()

Sélectionne tous les éléments figurant sur la scène ; cette méthode est l’équivalent des raccourcis clavier Ctrl+A (Windows) ou Commande+A (Macintosh), ou de l’option de menu Edition > Sélectionner tout.

document.selectNone()

Désélectionne les éléments sélectionnés.

document.setAlignToDocument()

Définit les préférences afin d'activer document.align(), document.distribute(), document.match() et document.space() pour le document. Cette commande est équivalente à l’activation de l'option Sur la scène du panneau Aligner.

document.setBlendMode()

Définit le mode de fondu pour les objets sélectionnés.

document.setCustomFill()

Définit les paramètres de remplissage pour le panneau Outils, l'inspecteur Propriétés et les formes sélectionnées, le cas échéant.

document.setCustomStroke()

Définit les paramètres de trait pour le panneau Outils, l'inspecteur Propriétés et les formes sélectionnées, le cas échéant.

document.setElementProperty()

Définit la propriété Element spécifiée pour le ou les objets sélectionnés du document.

document.setElementTextAttr()

Définit selon la valeur spécifiée la propriété TextAttrs spécifiée pour les éléments de texte sélectionnés.

document.setFillColor()

Modifie la couleur de remplissage de la sélection avec la couleur spécifiée.

document.setFilterProperty()

Définit la propriété de filtre spécifiée pour le ou les objets sélectionnés.

document.setFilters()

Applique des filtres aux objets sélectionnés.

document.setInstanceAlpha()

Définit l’opacité de l’occurrence.

document.setInstanceBrightness()

Définit la luminosité de l’occurrence.

document.setInstanceTint()

Définit la teinte de l’occurrence.

document.setMetadata()

Définit les métadonnées XML du document spécifié, en remplacement des métadonnées existantes.

document.setMobileSettings()

Définit la valeur d'une chaîne de paramètres XML dans un fichier FLA mobile.

document.setOvalObjectProperty()

Spécifie la valeur d'une propriété spécifiée des objets Oval de type primitif.

document.setPlayerVersion()

Définit la version de Flash Player ciblée par le document spécifié.

document.setRectangleObjectProperty()

Spécifie la valeur d'une propriété spécifiée des objets Rectangle de type primitif.

document.setSelectionBounds()

Déplace et redimensionne la sélection en une seule opération.

document.setSelectionRect()

Trace un cadre de sélection rectangulaire sur la scène, à partir des coordonnées spécifiées.

document.setStageVanishingPoint()

Spécifie le point de fuite pour l'affichage des objets 3D.

document.setStageViewAngle()

Spécifie l'angle de perspective pour l'affichage des objets 3D.

document.setStroke()

Définit la couleur, la largeur et le style des traits sélectionnés.

document.setStrokeColor()

Modifie la couleur de trait de la sélection avec la couleur spécifiée.

document.setStrokeSize()

Modifie la taille de trait de la sélection avec la taille spécifiée.

document.setStrokeStyle()

Modifie le style de trait de la sélection avec le style spécifié.

document.setTextRectangle()

Modifie le rectangle de délimitation de l’élément de texte sélectionné en lui donnant la taille spécifiée.

document.setTextSelection()

Définit la sélection de texte du champ de texte sélectionné avec les valeurs spécifiées dans startIndex et endIndex.

document.setTextString()

Insère une chaîne de texte.

document.setTransformationPoint()

Déplace le point de transformation de la sélection.

document.skewSelection()

Incline la sélection de la valeur spécifiée.

document.smoothSelection()

Lisse la courbe de chaque contour de remplissage ou segment incurvé sélectionné.

document.space()

Espace régulièrement les objets sélectionnés.

document.straightenSelection()

Redresse les traits sélectionnés ; cette méthode est l’équivalent du bouton Redresser dans le panneau Outils.

document.swapElement()

Intervertit la sélection actuelle avec la sélection spécifiée.

document.swapStrokeAndFill()

Permute les couleurs de trait et de remplissage.

document.synchronizeWithHeadVersion()

Synchronise le document spécifié avec la version la plus récente trouvée sur le serveur Version Cue et consigne les éventuelles erreurs dans le panneau Sortie.

document.testMovie()

Exécute une opération Tester l'animation sur le document.

document.testScene()

Exécute une opération Tester la séquence sur la séquence active dans le document.

document.traceBitmap()

Convertit le bitmap sélectionné en graphique vectoriel ; cette méthode est l’équivalent de l’option de menu Modification > Bitmap > Tracer le bitmap.

document.transformSelection()

Effectue une transformation générale de la sélection, en appliquant la matrice transmise en arguments.

document.translate3DCenter()

Définit la position XYZ autour de laquelle est effectuée la translation ou la rotation de la sélection.

document.translate3DSelection()

Applique une translation 3D à la sélection.

document.unGroup()

Dissocie la sélection.

document.union()

Combine toutes les formes sélectionnées sous forme d’un objet de dessin.

document.unlockAllElements()

Déverrouille tous les éléments verrouillés dans l’image sélectionnée.

document.xmlPanel()

Envoie une boîte de dialogue XMLUI.

Résumé des propriétés

Vous pouvez utiliser les propriétés suivantes avec l’objet Document :

Propriété

Description

document.accName

Chaîne équivalente au champ Nom du panneau Accessibilité.

document.as3AutoDeclare

Valeur booléenne indiquant si les occurrences placées sur la scène sont automatiquement ajoutées aux classes Timeline (scénario) définies par l'utilisateur.

document.as3Dialect

Chaîne décrivant le « dialecte » d'ActionScript 3.0 utilisé dans le document spécifié.

document.as3ExportFrame

Entier spécifiant dans quelle image exporter les classes ActionScript 3.0.

document.as3StrictMode

Valeur booléenne spécifiant si le compilateur ActionScript 3.0 doit compiler avec l'option du mode strict activée ou non.

document.as3WarningsMode

Valeur booléenne spécifiant si le compilateur ActionScript 3.0 doit compiler avec l'option Mode avertissements activée ou non.

document.asVersion

Entier indiquant la version ActionScript utilisée dans le fichier spécifié.

document.autoLabel

Valeur booléenne équivalente à la case à cocher Etiquetage auto du panneau Accessibilité.

document.backgroundColor

Chaîne, valeur hexadécimale ou entier représentant la couleur d'arrière-plan.

document.currentPublishProfile

Chaîne spécifiant le nom du profil de publication actif pour le document spécifié.

document.currentTimeline

Nombre entier spécifiant l’index du scénario actif.

document.description

Chaîne équivalente au champ Description du panneau Accessibilité.

document.docClass

Spécifie la classe ActionScript 3.0 de niveau supérieur qui est associée au document.

document.externalLibraryPath

Chaîne qui contient la liste des éléments du chemin de bibliothèque externe ActionScript 3.0 du document, spécifiant l'emplacement des fichiers SWC utilisés en tant que bibliothèques partagées par le moteur d'exécution.

document.forceSimple

Valeur booléenne indiquant si les enfants de l’objet spécifié sont accessibles.

document.frameRate

Nombre en virgule flottante indiquant le nombre d’images affichées par seconde pendant la lecture du fichier SWF ; cette valeur est 12 par défaut.

document.height

Nombre entier indiquant la hauteur en pixels du document (scène).

document.id

Nombre entier unique (attribué automatiquement) qui identifie un document pendant une session Flash.

document.library

Lecture seule ; Objet library d'un document.

document.libraryPath

Chaîne qui contient la liste des éléments de chemin de la bibliothèque ActionScript 3.0 du document, spécifiant l'emplacement des fichiers SWC ou des dossiers les contenant.

document.livePreview

Valeur booléenne indiquant si la fonction Aperçu en direct est activée.

document.name

Lecture seule ; chaîne représentant le nom d’un document (fichier FLA).

document.path

Lecture seule ; chaîne représentant le chemin d’accès du document dans un format spécifique à la plate-forme.

document.pathURI

Lecture seule ; chaîne représentant le chemin d’accès du document, exprimée sous la forme « fichier:/// URI ».

document.publishProfiles

Lecture seule ; tableau des noms des profils de publication du document.

document.screenOutline

Lecture seule ; Objet ScreenOutline actuel du document.

document.selection

Tableau des objets sélectionnés dans le document.

document.silent

Valeur booléenne indiquant si l’objet est accessible.

document.sourcePath

Propriété ; chaîne qui contient la liste des éléments du chemin source ActionScript 3.0 du document, spécifiant l'emplacement des fichiers de classe ActionScript.

document.timelines

Lecture seule ; tableau des objets Timeline (voir Objet Timeline).

document.viewMatrix

Lecture seule ; Objet Matrix.

document.width

Nombre entier indiquant la largeur en pixels du document (scène).

document.zoomFactor

Spécifie le pourcentage de zoom de la scène lors de la programmation.