Workbook classe

Workbook classe

Représente un objet racine pour créer une feuille de calcul Excel.

Le type Workbook expose les membres suivants :

Constructeurs

Constructeur Description
Workbook() Initialise une nouvelle instance de la classe Workbook.
Workbook(file_format_type) Initialise une nouvelle instance de la classe Workbook.
Workbook(file) Initialise une nouvelle instance de la classe Workbook et ouvre un fichier.
Workbook(stream) Initialise une nouvelle instance de la classe Workbook et ouvre un flux.
Workbook(file, load_options) Initialise une nouvelle instance de la classe Workbook et ouvre un fichier.
Workbook(stream, load_options) Initialise une nouvelle instance de la classe Workbook et du flux ouvert.

Propriétés

Propriété Description
settings Représente les paramètres du classeur.
worksheets Obtient la collection WorksheetCollection dans la feuille de calcul.
is_licensed Indique si la licence est définie.
colors Renvoie les couleurs dans la palette de la feuille de calcul.
count_of_styles_in_pool Obtient le nombre de styles dans le pool de styles.
default_style Obtient ou définit l’objet par défaut Style du classeur.
is_digitally_signed Indique si cette feuille de calcul est signée numériquement.
is_workbook_protected_with_password Indique si la structure ou la fenêtre est protégée par mot de passe.
vba_project Obtient le Workbook.vba_project dans une feuille de calcul.
has_macro Indique si cette feuille de calcul contient macro/VBA.
has_revisions Obtient si le classeur contient des modifications suivies
file_name Obtient et définit le nom de fichier actuel.
cells_data_table_factory Obtient la fabrique pour construire ICellsDataTable à partir d’objets personnalisés
data_sorter Obtient un objet DataSorter pour trier les données.
theme Obtient le nom du thème.
built_in_document_properties Renvoie une collection DocumentProperty qui représente toutes les propriétés de document intégrées de la feuille de calcul.
custom_document_properties Renvoie une collection DocumentProperty qui représente toutes les propriétés de document personnalisées de la feuille de calcul.
file_format Obtient et définit le format de fichier.
interrupt_monitor Obtient et définit le moniteur d’interruption.
content_type_properties Obtient la liste des objets ContentTypeProperty dans le classeur.
custom_xml_parts Représente une partie de stockage de données XML personnalisée (données XML personnalisées dans un package).
data_mashup Obtient des données de mashup.
ribbon_xml Obtient et définit le fichier XML qui définit l’interface utilisateur du ruban.
absolute_path Obtient et définit le chemin absolu du fichier.
data_connections Obtient la collection ExternalConnection.

Méthodes

Méthode Description
save(file_name, save_format) Enregistre le classeur sur le disque.
save(file_name) Enregistrez le classeur sur le disque.
save(file_name, save_options) Enregistre le classeur sur le disque.
save(stream, save_format) Enregistre le classeur dans le flux.
save(stream, save_options) Enregistre le classeur dans le flux.
replace(place_holder, new_value) Remplace la valeur d’une cellule par une nouvelle chaîne.
replace(place_holder, new_value) Remplace la valeur d’une cellule par un nouvel entier.
replace(place_holder, new_value) Remplace la valeur d’une cellule par un nouveau double.
replace(place_holder, new_values, is_vertical) Remplace la valeur d’une cellule par un nouveau tableau de chaînes.
replace(place_holder, new_values, is_vertical) Remplace les valeurs des cellules par un tableau d’entiers.
replace(place_holder, new_values, is_vertical) Remplace les valeurs des cellules par un double tableau.
replace(bool_value, new_value) Remplace les valeurs des cellules par de nouvelles données.
replace(int_value, new_value) Remplace les valeurs des cellules par de nouvelles données.
replace(place_holder, new_value, options) Remplace la valeur d’une cellule par une nouvelle chaîne.
copy(source, copy_options) Copie les données d’un objet Workbook source.
copy(source) Copie les données d’un objet Workbook source.
calculate_formula() Calcule le résultat de formules.
calculate_formula(ignore_error) Calcule le résultat de formules.
calculate_formula(ignore_error, custom_function) Calcule le résultat de formules.
calculate_formula(options) Calculer des formules dans ce classeur.
refresh_dynamic_array_formulas(calculate) Actualise les formules de tableau dynamique (débordement dans une nouvelle plage de cellules voisines en fonction des données actuelles)
Les autres formules du classeur ne seront pas calculées de manière récursive même si elles ont été utilisées par des formules matricielles dynamiques.
refresh_dynamic_array_formulas(calculate, copts) Actualise les formules de tableau dynamique (débordement dans une nouvelle plage de cellules voisines en fonction des données actuelles)
import_xml(url, sheet_name, row, col) Importe/met à jour un fichier de données XML dans le classeur.
import_xml(stream, sheet_name, row, col) Importe/met à jour un fichier de données XML dans le classeur.
export_xml(map_name, path) Exporter les données XML liées par le mappage XML spécifié.
export_xml(map_name, stream) Exporter des données XML.
parse_formulas(ignore_error) Analyse toutes les formules qui n’ont pas été analysées lorsqu’elles ont été chargées à partir d’un fichier de modèle ou définies dans une cellule.
start_access_cache(opts) Démarre la session qui utilise les caches pour accéder aux données.
close_access_cache(opts) Ferme la session qui utilise les caches pour accéder aux données.
remove_unused_styles() Supprimez tous les styles inutilisés.
create_style() Crée un nouveau style.
create_builtin_style(type) Crée un style intégré par type donné.
create_cells_color() Crée un objet CellsColor.
combine(second_workbook) Combine un autre objet Workbook.
get_style_in_pool(index) Obtient le style dans le pool de styles.
Tous les styles du classeur seront rassemblés dans un pool.
Il n’y a qu’un simple index de référence dans les cellules.
get_fonts() Obtient toutes les polices du pool de styles.
get_named_style(name) Obtient le style nommé dans le pool de styles.
change_palette(color, index) Modifie la palette de la feuille de calcul dans l’index spécifié.
is_color_in_palette(color) Vérifie si une couleur se trouve dans la palette de la feuille de calcul.
get_matching_color(raw_color) Trouvez la meilleure couleur correspondante dans la palette actuelle.
set_encryption_options(encryption_type, key_length) Définissez les options de chiffrement.
protect(protection_type, password) Protège un classeur.
protect_shared_workbook(password) Protège un classeur partagé.
unprotect(password) Déprotége un classeur.
unprotect_shared_workbook(password) Déprotége un classeur partagé.
remove_macro() Supprime VBA/macro de cette feuille de calcul.
remove_digital_signature() Supprime la signature numérique de cette feuille de calcul.
accept_all_revisions() Accepte toutes les modifications suivies dans le classeur.
remove_external_links() Supprime tous les liens externes du classeur.
get_theme_color(type) Obtient la couleur du thème.
set_theme_color(type, color) Définit la couleur du thème
custom_theme(theme_name, colors) Customise le thème.
copy_theme(source) Copie le thème d’un autre classeur.
has_exernal_links() Indique si ce classeur contient des liens externes vers d’autres sources de données.
update_linked_data_source(external_workbooks) Si ce classeur contient des liens externes vers d’autres sources de données,
Aspose.Cells tentera de récupérer les dernières données.
set_digital_signature(digital_signature_collection) Définit la signature numérique d’un fichier de feuille de calcul (Excel2007 et versions ultérieures).
add_digital_signature(digital_signature_collection) Ajoute une signature numérique à un fichier de feuille de calcul OOXML (Excel2007 et versions ultérieures).
get_digital_signature() Obtient la signature numérique du fichier.
remove_personal_information() Supprime les informations personnelles.

Remarques

La classe Workbook désigne une feuille de calcul Excel. Chaque feuille de calcul peut contenir plusieurs feuilles de calcul. La fonctionnalité de base de la classe est d’ouvrir et d’enregistrer des fichiers Excel natifs. La classe possède des fonctionnalités avancées telles que la copie de données à partir d’autres classeurs, la combinaison de deux classeurs et la protection de la feuille de calcul Excel.

Exemple

L’exemple suivant charge un Workbook à partir d’un fichier nommé designer.xls et rend les barres de défilement horizontale et verticale invisibles pour le Workbook. Il remplace ensuite deux valeurs de chaîne par une valeur entière et une valeur de chaîne respectivement dans la feuille de calcul et envoie enfin le fichier mis à jour à le navigateur client.

from aspose.cells import Workbook

# Open a designer file
designerFile = "designer.xls"
workbook = Workbook(designerFile)
# Set scroll bars
workbook.settings.is_h_scroll_bar_visible = False
workbook.settings.is_v_scroll_bar_visible = False
# Replace the placeholder string with new values
newInt = 100
workbook.replace("OldInt", newInt)
newString = "Hello!"
workbook.replace("OldString", newString)
workbook.save("result.xls")

Voir également