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

ConstructeurDescription
__init__(self)Initialise une nouvelle instance de la classe Workbook.
__init__(self, file_format_type)Initialise une nouvelle instance de la classe Workbook.
__init__(self, file)Initialise une nouvelle instance de la classe Workbook et ouvre un fichier.
__init__(self, stream)Initialise une nouvelle instance de la classe Workbook et ouvre un flux.
__init__(self, file, load_options)Initialise une nouvelle instance de la classe Workbook et ouvre un fichier.
__init__(self, stream, load_options)Initialise une nouvelle instance de la classe Workbook et ouvre le flux.

Propriétés

PropriétéDescription
settingsReprésente les paramètres du classeur.
worksheetsObtient la collection WorksheetCollection dans la feuille de calcul.
is_licensedIndique si la licence est définie.
colorsRenvoie les couleurs de la palette de la feuille de calcul.
count_of_styles_in_poolObtient le nombre de styles dans le pool de styles.
default_styleObtient ou définit l’objet Style par défaut du classeur.
is_digitally_signedIndique si cette feuille de calcul est signée numériquement.
is_workbook_protected_with_passwordIndique si la structure ou la fenêtre est protégée par un mot de passe.
vba_projectObtient le Workbook.vba_project dans une feuille de calcul.
has_macroIndique si cette feuille de calcul contient des macros/VBA.
has_revisionsObtient si le classeur a des modifications suivies
file_nameObtient et définit le nom du fichier actuel.
cells_data_table_factoryObtient l’usine pour construire ICellsDataTable à partir d’objets personnalisés
data_sorterObtient un objet DataSorter pour trier les données.
themeObtient le nom du thème.
built_in_document_propertiesRenvoie une collection DocumentProperty qui représente toutes les propriétés de document intégrées de la feuille de calcul.
custom_document_propertiesRenvoie une collection DocumentProperty qui représente toutes les propriétés de document personnalisées de la feuille de calcul.
file_formatObtient et définit le format du fichier.
has_custom_functionDétecte si une fonction personnalisée est utilisée dans ce classeur,
comme dans la formule d’une cellule, dans les noms définis…
content_type_propertiesObtient la liste des ContentTypeProperty objets dans le classeur.
custom_xml_partsReprésente une partie de stockage de données XML personnalisée (données XML personnalisées dans un package).
data_mashupObtient les données de mashup.
ribbon_xmlObtient et définit le fichier XML qui définit l’interface utilisateur du ruban.
absolute_pathObtient et définit le chemin absolu du fichier.
data_connectionsObtient la collection ExternalConnection.
data_modelObtient le modèle de données dans le classeur.

Méthodes

MéthodeDescription
save(self, file_name, save_format)Enregistre le classeur sur le disque.
save(self, file_name)Enregistrez le classeur sur le disque.
save(self, file_name, save_options)Enregistre le classeur sur le disque.
save(self, stream, save_format)Enregistre le classeur dans le flux.
save(self, stream, save_options)Enregistre le classeur dans le flux.
create_style(self)Crée un nouveau style.
create_style(self, clone_default_style)Crée un nouveau style.
replace(self, place_holder, new_value)Remplace la valeur d’une cellule par une nouvelle chaîne.
replace(self, place_holder, new_value)Remplace la valeur d’une cellule par un nouvel entier.
replace(self, place_holder, new_value)Remplace la valeur d’une cellule par un nouveau double.
replace(self, place_holder, new_values, is_vertical)Remplace la valeur d’une cellule par un nouveau tableau de chaînes.
replace(self, place_holder, new_values, is_vertical)Remplace les valeurs des cellules par un tableau d’entiers.
replace(self, place_holder, new_values, is_vertical)Remplace les valeurs des cellules par un tableau double.
replace(self, bool_value, new_value)Remplace les valeurs des cellules par de nouvelles données.
replace(self, int_value, new_value)Remplace les valeurs des cellules par de nouvelles données.
replace(self, place_holder, new_value, options)Remplace la valeur d’une cellule par une nouvelle chaîne.
copy(self, source, copy_options)Copie un autre objet Workbook.
copy(self, source)Copie les données d’un objet Workbook source.
calculate_formula(self)Calcule le résultat des formules.
calculate_formula(self, ignore_error)Calcule le résultat des formules.
calculate_formula(self, options)Calcul des formules dans ce classeur.
refresh_dynamic_array_formulas(self, calculate)Actualise les formules de tableau dynamiques (déversement 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 de tableau dynamique.
refresh_dynamic_array_formulas(self, calculate, copts)Actualise les formules de tableau dynamiques (déversement dans une nouvelle plage de cellules voisines en fonction des données actuelles)
import_xml(self, url, sheet_name, row, col)Importe/met à jour un fichier de données XML dans le classeur.
import_xml(self, stream, sheet_name, row, col)Importe/met à jour un fichier de données XML dans le classeur.
export_xml(self, map_name, path)Exporter les données XML liées par la carte XML spécifiée.
export_xml(self, map_name, stream)Exporter des données XML.
parse_formulas(self, ignore_error)Analyse toutes les formules qui n’ont pas été analysées lorsqu’elles ont été chargées à partir d’un fichier modèle ou définies dans une cellule.
start_access_cache(self, opts)Démarre la session qui utilise les caches pour accéder aux données.
close_access_cache(self, opts)Ferme la session qui utilise les caches pour accéder aux données.
remove_unused_styles(self)Supprimez tous les styles inutilisés.
create_builtin_style(self, type)Crée un style intégré selon le type donné.
create_cells_color(self)Crée un objet CellsColor.
combine(self, second_workbook)Combine un autre objet Workbook.
get_style_in_pool(self, 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(self)Obtient toutes les polices du pool de styles.
get_named_style(self, name)Obtient le style nommé dans le pool de styles.
merge_named_styles(self, source)Fusionne les styles nommés de l’autre fichier Excel.
change_palette(self, color, index)Modifie la palette de la feuille de calcul dans l’index spécifié.
is_color_in_palette(self, color)Vérifie si une couleur est dans la palette de la feuille de calcul.
get_matching_color(self, raw_color)Trouvez la couleur la plus correspondante dans la palette actuelle.
set_encryption_options(self, encryption_type, key_length)Définir les options de cryptage.
protect(self, protection_type, password)Protège un classeur.
protect_shared_workbook(self, password)Protège un classeur partagé.
unprotect(self, password)Déprotège un classeur.
unprotect_shared_workbook(self, password)Déprotège un classeur partagé.
remove_macro(self)Supprime VBA/macro de cette feuille de calcul.
remove_digital_signature(self)Supprime la signature numérique de cette feuille de calcul.
accept_all_revisions(self)Accepte toutes les modifications suivies dans le classeur.
remove_external_links(self)Supprime tous les liens externes dans le classeur.
get_theme_color(self, type)Obtient la couleur du thème.
set_theme_color(self, type, color)Définit la couleur du thème
custom_theme(self, theme_name, colors)Les coutumes sont le thème.
copy_theme(self, source)Copie le thème d’un autre classeur.
has_exernal_links(self)Indique si ce classeur contient des liens externes vers d’autres sources de données.
update_custom_function_definition(self, definition)Met à jour la définition des fonctions personnalisées.
update_linked_data_source(self, 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 à partir des sources données.
set_digital_signature(self, digital_signature_collection)Définit la signature numérique sur un fichier de feuille de calcul (Excel 2007 et versions ultérieures).
add_digital_signature(self, digital_signature_collection)Ajoute une signature numérique à un fichier de feuille de calcul OOXML (Excel 2007 et versions ultérieures).
get_digital_signature(self)Obtient la signature numérique du fichier.
remove_personal_information(self)Supprime les informations personnelles.
close(self)Dispose() est ignoré par le wrapper depuis le protocole Python

Remarques

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

Exemple

L’exemple suivant charge un Workbook à partir d’un fichier Excel nommé designer.xls et rend les barres de défilement horizontales et verticales invisibles. 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 enregistre enfin le classeur sous forme de fichier Excel xlsx.

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.xlsx")

Voir également