FichierAffiche (Fonction)

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

Version :

Accueil | Connexion | Français

Aide / WLangage / Fonctions WLangage / Fonctions spécifiques au WEB / Fonctions diverses WEBDEV

Choisir la destination du fichier
Récupérer les paramètres passés à une page AWP
Téléchargement de fichiers volumineux
Sessions prélancées
Webservices

WINDEV

WEBDEV

WINDEV Mobile

Autres

Voir Aussi

FichierAffiche (Fonction)

En anglais : FileDisplay

Non disponible

Affiche un fichier sur le navigateur de l'internaute. Permet d'afficher sur le navigateur de l'internaute des documents qui ne sont pas accessibles au serveur Web : fichiers cachés pour des raisons de sécurité, mémo binaires, ...

Il est également possible de proposer à l'internaute de télécharger le fichier. Pour plus de détails, consultez Download de fichiers (téléchargement). Après l'exécution de la fonction FichierAffiche, l'exécution du site continue, mais la requête est ignorée (une fonction PageActualise serait par exemple ignorée).

Les fichiers affichés peuvent être :

soit une page quelconque, accessible sur Internet ou sur un réseau local.
soit une page AWP en précisant la valeur des paramètres attendus par la page. Ces paramètres pourront être récupérés :
- soit dans l'événement "Déclarations globales" de la page.
- soit avec la fonction PageParamètre.

Exemple

Voir des exemples supplémentaires

// Affiche une boîte de dialogue proposant à l'internaute
// de télécharger le fichier NOTES.TXT sur son poste. 
FichierAffiche(ComplèteRep(fRepWeb()) + "NOTES.TXT", ...
		"application/unknown", "Notes.TXT")

// Affiche une boîte de dialogue proposant à l'internaute
// de télécharger le fichier NOTES.TXT sur son poste. 
// Fichier NOTES.TXT dans le même répertoire que .PHP
FichierAffiche("NOTES.TXT", "application/unknown", "Notes.TXT")

// Affiche un fichier présent dans un répertoire protégé
// Ce fichier est affiché uniquement si l'utilisateur est autorisé
// Autorise est un booléen permettant de gérer les droits de l'utilisateur
SI Autorise = Vrai ALORS
	FichierAffiche("c:\date\protege\plan.gif", "image/gif")
SINON
	PageAffiche(PAGE_Erreur)
FIN

// -- Code de clic d'un bouton de type submit
// Affiche le fichier "MonFichier.PDF" 
// présent dans le répertoire "<NomDuProjet>_WEB"
sFichier est une chaîne
sFichier = fRepWeb() + "/MonFichier.pdf"
FichierAffiche(sFichier, "application/pdf")

// Page AWP : Vérifie qu'un numéro de livraison a bien été saisi 
// (le champ n'est pas vide et la taille du numéro est égale à 18)
SI SansEspace(SAI_NUMLIVRAISON) = "" OU ...
	Taille(SansEspace(SAI_NUMLIVRAISON)) = 18 ALORS
	// Reprend la saisie du numéro
	FichierAffiche("webdev_liv_number.awp?P1=1&P2=" + CODELANGUE)
FIN
FichierAffiche("webdev_liv_history.awp?P1=" + SAI_NUMLIVRAISON + ...
	"&P2=" + CODELANGUE)

Syntaxe

Utilisation en WEBDEV Serveur Masquer les détails

FichierAffiche(<Nom du fichier> [, <Type MIME> [, <Nom du fichier pour la sauvegarde>]])

<Nom du fichier> : Chaîne de caractères

Chemin complet du fichier à afficher dans le navigateur de l'internaute. Le fichier doit être accessible sur le serveur (droits, existence du fichier, ...).

<Type MIME> : Chaîne de caractères Ansi optionnelle

Nom du type MIME à utiliser. Le type MIME permet de préciser au navigateur le type du fichier qu'il doit manipuler. Des centaines de types sont définis dans la norme de communication MIME (disponible sur Internet). Les valeurs les plus courantes et reconnues par la plupart des navigateurs sont :
"text/html" : page HTML (*.htm, *.html) (par défaut)
"text/plain" : fichier texte (*.txt)
"application/pdf" : document au format PDF (*.pdf)
"image/gif" : image au format GIF (*.gif)
"image/jpeg" : image au format JPEG (*.jpg, *.jpeg)
"video/mpeg" : vidéo au format MPEG (*.mpg, *.mpeg)
"application/unknown" : permet d'afficher une boîte de dialogue pour proposer le téléchargement du fichier sur le poste de l'internaute.
"application/msword" : permet d'afficher un fichier Word.
"application/vnd.ms-excel" : permet d'afficher un fichier Excel.
Type MIME correspondant à une des constantes suivantes :
typeMimeApplicationXML Contenu de type XML.
typeMimeBinaire Contenu de type binaire (flux d'octets).
typeMimeDOC Contenu de type fichier Word (*.doc)
typeMimeDOCX Contenu de type fichier Word (*.docx)
typeMimeGIF Contenu de type image au format GIF (*.gif)
typeMimeHTML Contenu de type page HTML (*.htm, *.html)
typeMimeJPEG Contenu de type image au format JPEG (*.jpg, *.jpeg)
typeMimeJSON Contenu de type JSON.
typeMimePDF Contenu de type document PDF (*.pdf)
typeMimePNG Contenu de type image au format JPEG (*.png)
typeMimeSOAP Contenu SOAP au format XML.
typeMimeTexte Contenu au format texte (*.txt)
typeMimeTexteXML Contenu texte au format XML
typeMimeXLS Contenu au format Excel (*.xls)
typeMimeXLSX Contenu au format Excel (*.xlsx)
typeMimeZIP Contenu au format ZIP (*.zip)

<Nom du fichier pour la sauvegarde> : Chaîne de caractères optionnelle

Nom du fichier à sauvegarder si l'internaute choisit de télécharger le fichier sur son poste. Si ce paramètre est spécifié, le téléchargement du fichier est automatiquement proposé.

Utilisation en WEBDEV Navigateur Masquer les détails

FichierAffiche(<Adresse de la page> [, <Destination>] , <Nom de la fenêtre> [, <Options> [, <Largeur> [, <Hauteur> [, <Position horizontale> [, <Position verticale> [, <Paramètres Javascript>]]]]]])

<Adresse de la page> : Chaîne de caractères

Adresse URL de la page à afficher dans la nouvelle fenêtre du navigateur. Si ce paramètre correspond à une chaîne vide (""), une page blanche est ouverte ("about:blank").
Si la page à afficher est une page AWP avec paramètres, nom du fichier AWP suivi des paramètres à passer à la page AWP. Pour être récupérés directement dans l'événement "Déclarations globales" de la page, les paramètres doivent être nommés P1, P2, ..., P256.

<Destination> : Chaîne de caractères ou constante optionnelle

Nom de la frame de destination. <Destination> peut également prendre les valeurs suivantes :
FrameEnCours la destination est le cadre en cours (valeur par défaut).
Ce paramètre peut également correspondre à la chaîne "_self" (compatibilité avec WEBDEV 1.5).
FrameParent la destination est le conteneur de la page en cours (frameset parent, navigateur parent).
Ce paramètre peut également correspondre à la chaîne "_parent" (compatibilité avec WEBDEV 1.5).
NavigateurEnCours la destination est le navigateur en cours.
Ce paramètre peut également correspondre à la chaîne "_top" (compatibilité avec WEBDEV 1.5).
NouveauNavigateur la destination est un nouveau navigateur (une nouvelle fenêtre de navigateur est ouverte). Les paramètres suivants de la fonction FichierAffiche permettent de configurer cette nouvelle fenêtre.
Ce paramètre peut également correspondre à la chaîne "_blank" (compatibilité avec WEBDEV 1.5).

<Nom de la fenêtre> : Chaîne de caractères optionnelle

Nom de la nouvelle fenêtre du navigateur. Ce paramètre permet de réafficher une page dans une fenêtre de navigateur portant le même nom (si plusieurs fenêtres du navigateur sont ouvertes sur le poste de l'Internaute).

<Options> : Constante ou combinaison de constantes de type entier (optionnelle)

Paramètres de la nouvelle fenêtre du navigateur :
ONAdresse La barre d'adresse sera affichée
ONAscenseur Les barres de défilement seront affichées
ONComplet
(Valeur par défaut) La fenêtre du nouveau navigateur sera complète (équivalent à la combinaison de toutes les constantes précédentes)
ONDimension La fenêtre du nouveau navigateur sera redimensionnable
ONLien La barre des liens sera affichée
ONMenu La barre de menu sera affichée
ONMessage La barre de message sera affichée
ONOutils La barre d'outils sera affichée
ONSimple La fenêtre du nouveau navigateur sera minimale (aucune combinaison de constantes).

<Largeur> : Entier optionnel

Largeur en pixels de la nouvelle fenêtre du navigateur. Peut prendre pour valeur la constante Défaut.

<Hauteur> : Entier optionnel

Hauteur en pixels de la nouvelle fenêtre du navigateur. Peut prendre pour valeur la constante Défaut.

<Position horizontale> : Entier optionnel

Position horizontale en pixels de la nouvelle fenêtre du navigateur par rapport au coin haut gauche de l'écran principal. Peut prendre pour valeur la constante Défaut.

<Position verticale> : Entier optionnel

Position verticale en pixels de la nouvelle fenêtre du navigateur par rapport au coin haut gauche de l'écran principal. Peut prendre pour valeur la constante Défaut.

<Paramètres Javascript> : Chaîne de caractères optionnelle

Autres paramètres Javascript à utiliser lors de l'ouverture d'un nouveau navigateur si <Destination> est égal à "_blank".

Remarques

Choisir la destination du fichier

Pour choisir la destination du fichier, il est conseillé d'utiliser le paramètre <Destination> de la fonction FichierAffiche plutôt que la fonction ChangeDestination. En effet, dans ce cas, le code Javascript correspondant est plus petit et donc la taille de vos pages est optimisée.

Récupérer les paramètres passés à une page AWP

Plusieurs méthodes permettent de récupérer les paramètres passés à une page AWP :

Récupération des paramètres dans l'événement "Déclarations globales" de la page.
Récupération des paramètres grâce à la fonction PageParamètre.

Pour plus de détails, consultez Afficher une page AWP depuis une autre page.

Téléchargement de fichiers volumineux

Le téléchargement de fichiers via la fonction FichierAffiche peut être plus lent que le téléchargement direct par un lien http.

Dans le cas de la fonction FichierAffiche, le moteur WEBDEV :

Ouvre le fichier à télécharger.
Transfère le fichier au serveur Web en lui demandant d'envoyer le fichier vers l'internaute.

Dans le cas d'un lien http, c'est le navigateur de l'internaute qui va chercher directement le fichier à télécharger.

Pour des fichiers volumineux, il est conseillé d'utiliser un lien http. Dans ce cas, le chemin et le nom du fichier à télécharger peuvent être paramétrés grâce à la propriété URL.

Sessions prélancées

Si votre projet utilise les sessions prélancées, cette fonction ne doit pas être utilisée dans l'événement "Initialisation" du projet. Cette fonction doit être utilisée dans l'événement "Initialisation lors d'une connexion à une session prélancée".

Webservices

Cette fonction peut être utilisée dans les Webservices.

Classification Métier / UI : Code UI

Composante : wd300dllexe.dll

Voir Aussi

Version minimum requise

Version 9

Commentaires

Retour de cette fonction en WebDev

l'option :
"application/unknown" : permet d'afficher une boîte de dialogue pour proposer le téléchargement du fichier sur le poste de l'internaute.

Comment sait-on si l'utilisateur a annulé la sauvegarde du fichier ?
SUGGESTION SVP :
La fonction devrait retourner le chemin de sauvegarde du fichier choisi par l'utilisateur et vide dans le cas d'annulation (comme dans Windev)

Thierry ARBEILLE

06 mai 2017

Dernière modification : 01/07/2024

Signaler une erreur ou faire une suggestion | Aide en ligne locale